Chapter 3. OpenShift Pipelines tkn reference

Example: Display all options

$ tkn

Example: Completion code for bash shell

$ tkn completion bash

Example: Check the tkn version

$ tkn version

Example: Display help

$ tkn pipeline --help

Example: Delete a pipeline from a namespace

$ tkn pipeline delete <pipeline_name> -n <namespace_name>

Example: Describe a pipeline

$ tkn pipeline describe <pipeline_name>

Example: Display a list of pipelines

$ tkn pipeline list

Example: Stream the live logs for a pipeline

$ tkn pipeline logs -f <pipeline_name>

Example: Start a pipeline

$ tkn pipeline start <pipeline_name>

Example: Display help

$ tkn pipelinerun -h

Example: Cancel a pipeline run from a namespace

$ tkn pipelinerun cancel <pipeline_run_name> -n <namespace_name>

Example: Delete pipeline runs from a namespace

$ 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 1

Example: Delete all pipelines

$ tkn pipelinerun delete --all

Example: Describe a pipeline run in a namespace

$ tkn pipelinerun describe <pipeline_run_name> -n <namespace_name>

Example: Display a list of pipeline runs in a namespace

$ tkn pipelinerun list -n <namespace_name>

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>

Example: Display help

$ tkn task -h

Example: Delete tasks from a namespace

$ tkn task delete <task_name_1> <task_name_2> -n <namespace_name>

Example: Describe a task in a namespace

$ tkn task describe <task_name> -n <namespace_name>

Example: List all the tasks in a namespace

$ tkn task list -n <namespace_name>

Example: Start a task in a namespace

$ tkn task start <task_name> -s <service_account_name> -n <namespace_name>

Example: Display help

$ tkn taskrun -h

Example: Cancel a task run from a namespace

$ tkn taskrun cancel <task_run_name> -n <namespace_name>

Example: Delete task runs from a namespace

$ 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 1

Example: Describe a task run in a namespace

$ tkn taskrun describe <task_run_name> -n <namespace_name>

Example: List all the task runs in a namespace

$ tkn taskrun list -n <namespace_name>

Example: Display live logs for a task run in a namespace

$ tkn taskrun logs -f <task_run_name> -n <namespace_name>

Example: Display help

$ tkn resource -h

Example: Create a Pipeline Resource in a namespace

$ tkn resource create -n myspace

Example: Delete the myresource Pipeline Resource from a namespace

$ tkn resource delete myresource -n myspace

Example: Describe the myresource Pipeline Resource

$ tkn resource describe myresource -n myspace

Example: List all Pipeline Resources in a namespace

$ tkn resource list -n myspace

Example: Display help

$ tkn clustertask --help

Example: Delete mytask1 and mytask2 ClusterTasks

$ tkn clustertask delete mytask1 mytask2

Example: Describe the mytask ClusterTask

$ tkn clustertask describe mytask1

Example: List ClusterTasks

$ tkn clustertask list

Example: Start the mytask ClusterTask

$ tkn clustertask start mytask

Example: Display help

$ tkn eventlistener -h

Example: Delete mylistener1 and mylistener2 EventListeners in a namespace

$ tkn eventlistener delete mylistener1 mylistener2 -n myspace

Example: Describe the mylistener EventListener in a namespace

$ tkn eventlistener describe mylistener -n myspace

Example: List all the EventListeners in a namespace

$ tkn eventlistener list -n myspace

Example: Display the logs of the mylistener EventListener in a namespace

$ tkn eventlistener logs mylistener -n myspace

Example: Display TriggerBindings help

$ tkn triggerbinding -h

Example: Delete mybinding1 and mybinding2 TriggerBindings in a namespace

$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace

Example: Describe the mybinding TriggerBinding in a namespace

$ tkn triggerbinding describe mybinding -n myspace

Example: List all the TriggerBindings in a namespace

$ tkn triggerbinding list -n myspace

Example: Display TriggerTemplate help

$ tkn triggertemplate -h

Example: Delete mytemplate1 and mytemplate2 TriggerTemplates in a namespace

$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`

Example: Describe the mytemplate TriggerTemplate in a namespace

$ tkn triggertemplate describe mytemplate -n `myspace`

Example: List all the TriggerTemplates in a namespace

$ tkn triggertemplate list -n myspace

Example: Display ClusterTriggerBindings help

$ tkn clustertriggerbinding -h

Example: Delete myclusterbinding1 and myclusterbinding2 ClusterTriggerBindings

$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2

Example: Describe the myclusterbinding ClusterTriggerBinding

$ tkn clustertriggerbinding describe myclusterbinding

Example: List all ClusterTriggerBindings

$ tkn clustertriggerbinding list

Example: Display help

$ tkn hub -h

Example: Interact with a hub API server

$ tkn hub --api-server https://api.hub.tekton.dev

Example: Downgrade the mytask task in the mynamespace namespace to it’s older version

$ tkn hub downgrade task mytask --to version -n mynamespace

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

Example: Display information about a specific version of the mytask task from the tekton catalog

$ tkn hub info task mytask --from tekton --version 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

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

Example: Search a resource with a tag cli

$ tkn hub search --tags cli

Example: Upgrade the installed mytask task in the mynamespace namespace to a new version

$ tkn hub upgrade task mytask --to version -n mynamespace