5.3. OpenShift Pipelines tkn 参考

本节列出了基本的 tkn CLI 命令。

5.3.1. 基本语法

tkn [command or options] [arguments…​]

5.3.2. 全局选项

--help, -h

5.3.3. 工具命令

5.3.3.1. tkn

tkn CLI 的主命令。

示例： 显示所有选项

$ tkn

5.3.3.2. completion [shell]

输出 shell 完成代码，必须经过评估方可提供互动完成。支持的 shell 是 bash 和 zsh。

示例：bash shell 完成代码

$ tkn completion bash

5.3.3.3. version

输出 tkn CLI 的版本信息。

示例： 检查 tkn 版本

$ tkn version

5.3.4. Pipelines 管理命令

5.3.4.1. pipeline

管理管道。

示例： 显示帮助信息

$ tkn pipeline --help

5.3.4.2. pipeline delete

删除管道。

示例：从命名空间中删除 mypipeline 管道

$ tkn pipeline delete mypipeline -n myspace

5.3.4.3. pipeline describe

描述管道。

示例：描述 mypipeline 管道

$ tkn pipeline describe mypipeline

5.3.4.4. pipeline list

显示管道列表。

示例：显示管道列表

$ tkn pipeline list

5.3.4.5. pipeline logs

显示特定管道的日志。

示例：将 mypipeline 管道的 live 日志流

$ tkn pipeline logs -f mypipeline

5.3.4.6. pipeline start

启动管道。

示例：启动 mypipeline 管道

$ tkn pipeline start mypipeline

5.3.5. pipeline run 命令

5.3.5.1. pipelinerun

管理管道运行。

示例： 显示帮助信息

$ tkn pipelinerun -h

5.3.5.2. pipelinerun cancel

取消管道运行。

示例：取消从命名空间中运行的 mypipelinerun 管道

$ tkn pipelinerun cancel mypipelinerun -n myspace

5.3.5.3. pipelinerun delete

删除管道运行。

示例：删除管道从命名空间中运行

$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace

示例：删除所有管道从命名空间中运行，但最近执行的管道运行除外

$ tkn pipelinerun delete -n myspace --keep 5 1

1
使用您要保留的最新执行的管道运行数量替换 5。

示例：删除所有管道

$ tkn pipelinerun delete --all

注意

从 Red Hat OpenShift Pipelines 1.6 开始，tkn pipelinerun delete --all 命令不会删除处于 running 状态的任何资源。

5.3.5.4. pipelinerun describe

描述管道运行。

示例：描述在命名空间中运行的 mypipelinerun 管道

$ tkn pipelinerun describe mypipelinerun -n myspace

5.3.5.5. pipelinerun list

列出管道运行。

示例： 显示在命名空间中运行的管道列表

$ tkn pipelinerun list -n myspace

5.3.5.6. pipelinerun logs

显示管道运行的日志。

示例：显示 mypipelinerun 管道运行的日志，其中包含命名空间中的所有任务和步骤

$ tkn pipelinerun logs mypipelinerun -a -n myspace

5.3.6. 任务管理命令

5.3.6.1. task

管理任务。

示例： 显示帮助信息

$ tkn task -h

5.3.6.2. task delete

删除任务。

示例：从命名空间中删除 mytask1 和 mytask2 任务

$ tkn task delete mytask1 mytask2 -n myspace

5.3.6.3. task describe

描述任务。

示例：描述命名空间中的 mytask 任务

$ tkn task describe mytask -n myspace

5.3.6.4. task list

列出任务。

示例： 列出命名空间中的所有任务

$ tkn task list -n myspace

5.3.6.5. task logs

显示任务日志。

示例：显示 mytask 任务的 mytaskrun 任务运行的日志

$ tkn task logs mytask mytaskrun -n myspace

5.3.6.6. task start

启动一个任务。

示例： 在命名空间中启动 mytask 任务

$ tkn task start mytask -s <ServiceAccountName> -n myspace

5.3.7. task run 命令

5.3.7.1. taskrun

管理任务运行。

示例： 显示帮助信息

$ tkn taskrun -h

5.3.7.2. taskrun cancel

取消任务运行。

示例：取消从命名空间中运行的 mytaskrun 任务

$ tkn taskrun cancel mytaskrun -n myspace

5.3.7.3. taskrun delete

删除一个 TaskRun。

示例：从命名空间中删除 mytaskrun1 和 mytaskrun2 任务

$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace

示例：删除除五个最近执行的任务外从命名空间中运行的所有任务

$ tkn taskrun delete -n myspace --keep 5 1

1
将 5 替换为您要保留的最新执行任务数量。

5.3.7.4. taskrun describe

描述任务运行。

示例：描述在命名空间中运行的 mytaskrun 任务

$ tkn taskrun describe mytaskrun -n myspace

5.3.7.5. taskrun list

列出任务运行。

示例：列出所有任务在命名空间中运行

$ tkn taskrun list -n myspace

5.3.7.6. taskrun logs

显示任务运行日志.

示例：显示在命名空间中运行的 mytaskrun 任务的实时日志

$ tkn taskrun logs -f mytaskrun -n myspace

5.3.8. 条件管理命令

5.3.8.1. 条件

管理条件（Condition）。

示例： 显示帮助信息

$ tkn condition --help

5.3.8.2. 删除条件

删除一个条件。

示例：从命名空间中删除 mycondition1 Condition

$ tkn condition delete mycondition1 -n myspace

5.3.8.3. condition describe

描述条件。

示例：在命名空间中描述 mycondition1 Condition

$ tkn condition describe mycondition1 -n myspace

5.3.8.4. condition list

列出条件。

示例： 列出命名空间中的条件

$ tkn condition list -n myspace

5.3.9. Pipeline 资源管理命令

5.3.9.1. resource

管理管道资源。

示例： 显示帮助信息

$ tkn resource -h

5.3.9.2. resource create

创建一个 Pipeline 资源。

示例： 在命名空间中创建一个 Pipeline 资源

$ tkn resource create -n myspace

这是一个交互式命令，它要求输入资源名称、资源类型以及基于资源类型的值。

5.3.9.3. resource delete

删除 Pipeline 资源。

示例：从命名空间中删除 myresource Pipeline 资源

$ tkn resource delete myresource -n myspace

5.3.9.4. resource describe

描述管道资源。

示例：描述 myresource Pipeline 资源

$ tkn resource describe myresource -n myspace

5.3.9.5. resource list

列出管道资源。

示例： 列出命名空间中的所有管道资源

$ tkn resource list -n myspace

5.3.10. ClusterTask 管理命令

重要

在 Red Hat OpenShift Pipelines 1.10 中，tkn 命令行工具的 ClusterTask 功能已弃用，计划在以后的发行版本中删除。

5.3.10.1. clustertask

管理 ClusterTasks。

示例： 显示帮助信息

$ tkn clustertask --help

5.3.10.2. clustertask delete

删除集群中的 ClusterTask 资源。

示例： 删除 mytask1 和 mytask2 ClusterTasks

$ tkn clustertask delete mytask1 mytask2

5.3.10.3. clustertask describe

描述 ClusterTask。

示例： 描述 mytask ClusterTask

$ tkn clustertask describe mytask1

5.3.10.4. clustertask list

列出 ClusterTasks。

示例： 列出 ClusterTasks

$ tkn clustertask list

5.3.10.5. clustertask start

启动 ClusterTasks。

示例： 启动 mytask ClusterTask

$ tkn clustertask start mytask

5.3.11. 触发器管理命令

5.3.11.1. eventlistener

管理 EventListeners。

示例： 显示帮助信息

$ tkn eventlistener -h

5.3.11.2. eventlistener delete

删除一个 EventListener。

示例：删除命令空间中的 mylistener1 和 mylistener2 EventListeners

$ tkn eventlistener delete mylistener1 mylistener2 -n myspace

5.3.11.3. eventlistener describe

描述 EventListener。

示例：描述命名空间中的 mylistener EventListener

$ tkn eventlistener describe mylistener -n myspace

5.3.11.4. eventlistener list

列出 EventListeners。

示例： 列出命名空间中的所有 EventListeners

$ tkn eventlistener list -n myspace

5.3.11.5. eventListener 日志

显示 EventListener 的日志。

示例： 在一个命名空间中显示 mylistener EventListener 的日志

$ tkn eventlistener logs mylistener -n myspace

5.3.11.6. triggerbinding

管理 TriggerBindings。

示例： 显示 TriggerBindings 帮助信息

$ tkn triggerbinding -h

5.3.11.7. triggerbinding delete

删除 TriggerBinding。

示例：删除一个命名空间中的 mybinding1 和 mybinding2 TriggerBindings

$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace

5.3.11.8. triggerbinding describe

描述 TriggerBinding。

示例：描述命名空间中的 mybinding TriggerBinding

$ tkn triggerbinding describe mybinding -n myspace

5.3.11.9. triggerbinding list

列出 TriggerBindings。

示例： 列出命名空间中的所有 TriggerBindings

$ tkn triggerbinding list -n myspace

5.3.11.10. triggertemplate

管理 TriggerTemplates。

示例： 显示 TriggerTemplate 帮助

$ tkn triggertemplate -h

5.3.11.11. triggertemplate delete

删除 TriggerTemplate。

示例：删除命名空间中的 mytemplate1 和 mytemplate2 TriggerTemplates

$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`

5.3.11.12. triggertemplate describe

描述 TriggerTemplate。

示例： 描述命名空间中的 mytemplate TriggerTemplate

$ tkn triggertemplate describe mytemplate -n `myspace`

5.3.11.13. triggertemplate list

列出 TriggerTemplates。

示例： 列出命名空间中的所有 TriggerTemplates

$ tkn triggertemplate list -n myspace

5.3.11.14. clustertriggerbinding

管理 ClusterTriggerBindings。

示例： 显示 ClusterTriggerBindings 帮助信息

$ tkn clustertriggerbinding -h

5.3.11.15. clustertriggerbinding delete

删除 ClusterTriggerBinding。

示例： 删除 myclusterbinding1 和 myclusterbinding2 ClusterTriggerBindings

$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2

5.3.11.16. clustertriggerbinding describe

描述 ClusterTriggerBinding。

示例： 描述 myclusterbinding ClusterTriggerBinding

$ tkn clustertriggerbinding describe myclusterbinding

5.3.11.17. clustertriggerbinding list

列出 ClusterTriggerBindings。

示例： 列出所有 ClusterTriggerBindings

$ tkn clustertriggerbinding list

5.3.12. hub 互动命令

与 Tekton Hub 交互，以获取任务和管道等资源。

5.3.12.1. hub

与 hub 交互。

示例： 显示帮助信息

$ tkn hub -h

示例：与 hub API 服务器交互

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

注意

对于每个示例，若要获取对应的子命令和标记，请运行 tkn hub <command> --help。

5.3.12.2. hub downgrade

对一个安装的资源进行降级。

示例：将 mynamespace 命名空间中的 mytask 任务降级到它的较旧版本

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

5.3.12.3. hub get

按名称、类型、目录和版本获取资源清单。

示例：从 tekton 目录中获取 myresource 管道或任务的特定版本的清单

$ tkn hub get [pipeline | task] myresource --from tekton --version version

5.3.12.4. hub info

按名称、类型、目录和版本显示资源的信息。

示例：显示 tekton 目录中有关 mytask 任务的特定版本的信息

$ tkn hub info task mytask --from tekton --version version

5.3.12.5. hub install

按类型、名称和版本从目录安装资源。

示例：从 mynamespace 命名空间中的 tekton 目录安装 mytask 任务的特定版本

$ tkn hub install task mytask --from tekton --version version -n mynamespace

5.3.12.6. hub reinstall

按类型和名称重新安装资源。

示例：从 mynamespace 命名空间中的 tekton 目录重新安装 mytask 任务的特定版本

$ tkn hub reinstall task mytask --from tekton --version version -n mynamespace

5.3.12.8. hub upgrade

升级已安装的资源。

示例：将 mynamespace 命名空间中安装的 mytask 任务升级到新版本

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