OpenShift 文档正在迁移，很快将仅在 docs.redhat.com（所有 Red Hat 产品文档的所在地）提供。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

OpenShift Pipelines tkn 参考

基本语法

tkn [命令或选项] [参数…​]

全局选项

--help, -h

实用程序命令

tkn

tkn CLI 的父命令。

示例：显示所有选项
$ tkn

completion [shell]

打印必须评估才能提供交互式补全的 shell 补全代码。支持的 shell 为bash 和 zsh。

示例：bash shell 的补全代码
$ tkn completion bash

版本

打印 tkn CLI 的版本信息。

示例：检查 tkn 版本
$ tkn version

管道管理命令

pipeline

管理管道。

示例：显示帮助
$ tkn pipeline --help

pipeline delete

删除管道。

示例：从命名空间中删除 mypipeline 管道
$ tkn pipeline delete mypipeline -n myspace

pipeline describe

描述管道。

示例：描述 mypipeline 管道
$ tkn pipeline describe mypipeline

pipeline list

显示管道列表。

示例：显示管道列表
$ tkn pipeline list

pipeline logs

显示特定管道的日志。

示例：流式传输 mypipeline 管道的实时日志
$ tkn pipeline logs -f mypipeline

pipeline start

启动管道。

示例：启动 mypipeline 管道
$ tkn pipeline start mypipeline

管道运行命令

pipelinerun

管理管道运行。

示例：显示帮助
$ tkn pipelinerun -h

pipelinerun cancel

取消管道运行。

示例：从命名空间取消 mypipelinerun 管道运行
$ tkn pipelinerun cancel mypipelinerun -n myspace

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 命令不会删除任何处于运行状态的资源。

pipelinerun describe

描述管道运行。

示例：在命名空间中描述 mypipelinerun 管道运行
$ tkn pipelinerun describe mypipelinerun -n myspace

pipelinerun list

列出管道运行。

示例：显示命名空间中管道运行的列表
$ tkn pipelinerun list -n myspace

pipelinerun logs

显示管道运行的日志。

示例：显示命名空间中 mypipelinerun 管道运行的所有任务和步骤的日志
$ tkn pipelinerun logs mypipelinerun -a -n myspace

任务管理命令

task

管理任务。

示例：显示帮助
$ tkn task -h

task delete

删除任务。

示例：从命名空间中删除 mytask1 和 mytask2 任务
$ tkn task delete mytask1 mytask2 -n myspace

task describe

描述任务。

示例：在命名空间中描述 mytask 任务
$ tkn task describe mytask -n myspace

task list

列出任务。

示例：列出命名空间中的所有任务
$ tkn task list -n myspace

task logs

显示任务日志。

示例：显示 mytask 任务的 mytaskrun 任务运行的日志
$ tkn task logs mytask mytaskrun -n myspace

task start

启动任务。

示例：在命名空间中启动 mytask 任务
$ tkn task start mytask -s <ServiceAccountName> -n myspace

任务运行命令

taskrun

管理任务运行。

示例：显示帮助
$ tkn taskrun -h

taskrun cancel

取消任务运行。

示例：从命名空间取消 mytaskrun 任务运行
$ tkn taskrun cancel mytaskrun -n myspace

taskrun delete

删除 TaskRun。

示例：从命名空间删除 mytaskrun1 和 mytaskrun2 任务运行
$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
示例：删除命名空间中除最近执行的五个任务运行之外的所有任务运行。
$ tkn taskrun delete -n myspace --keep 5 (1)
1 将 5 替换为您想要保留的最近执行的任务运行数。

taskrun describe

描述任务运行。

示例：在命名空间中描述 mytaskrun 任务运行
$ tkn taskrun describe mytaskrun -n myspace

taskrun list

列出任务运行。

示例：列出命名空间中的所有任务运行
$ tkn taskrun list -n myspace

taskrun logs

显示任务运行日志。

示例：显示命名空间中 mytaskrun 任务运行的实时日志
$ tkn taskrun logs -f mytaskrun -n myspace

条件管理命令

condition

管理条件。

示例：显示帮助
$ tkn condition --help

condition delete

删除条件。

示例：从命名空间删除 mycondition1 条件
$ tkn condition delete mycondition1 -n myspace

condition describe

描述条件。

示例：在命名空间中描述 mycondition1 条件
$ tkn condition describe mycondition1 -n myspace

condition list

列出条件。

示例：列出命名空间中的条件
$ tkn condition list -n myspace

管道资源管理命令

resource

管理管道资源。

示例：显示帮助
$ tkn resource -h

resource create

创建管道资源。

示例：在命名空间中创建管道资源
$ tkn resource create -n myspace

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

resource delete

删除管道资源。

示例：从命名空间中删除 myresource 管道资源
$ tkn resource delete myresource -n myspace

resource describe

描述管道资源。

示例：描述 myresource 管道资源
$ tkn resource describe myresource -n myspace

resource list

列出管道资源。

示例：列出命名空间中的所有管道资源
$ tkn resource list -n myspace

ClusterTask 管理命令

在 Red Hat OpenShift Pipelines 1.10 中，tkn 命令行实用程序的 ClusterTask 功能已弃用，并计划在将来的版本中删除。

clustertask

管理 ClusterTasks。

示例：显示帮助
$ tkn clustertask --help

clustertask delete

删除集群中的 ClusterTask 资源。

示例：删除 mytask1 和 mytask2 ClusterTasks
$ tkn clustertask delete mytask1 mytask2

clustertask describe

描述 ClusterTask。

示例：描述 mytask ClusterTask
$ tkn clustertask describe mytask1

clustertask list

列出 ClusterTasks。

示例：列出 ClusterTasks
$ tkn clustertask list

clustertask start

启动 ClusterTasks。

示例：启动 mytask ClusterTask
$ tkn clustertask start mytask

触发器管理命令

eventlistener

管理 EventListeners。

示例：显示帮助
$ tkn eventlistener -h

eventlistener delete

删除 EventListener。

示例：在命名空间中删除 mylistener1 和 mylistener2 EventListeners
$ tkn eventlistener delete mylistener1 mylistener2 -n myspace

eventlistener describe

描述 EventListener。

示例：在命名空间中描述 mylistener EventListener
$ tkn eventlistener describe mylistener -n myspace

eventlistener list

列出 EventListeners。

示例：列出命名空间中的所有 EventListeners
$ tkn eventlistener list -n myspace

eventlistener logs

显示 EventListener 的日志。

示例：显示命名空间中 mylistener EventListener 的日志
$ tkn eventlistener logs mylistener -n myspace

triggerbinding

管理 TriggerBindings。

示例：显示 TriggerBindings 帮助
$ tkn triggerbinding -h

triggerbinding delete

删除 TriggerBinding。

示例：删除命名空间中的mybinding1和mybinding2 TriggerBindings
$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace

triggerbinding describe

描述 TriggerBinding。

示例：描述命名空间中的mybinding TriggerBinding
$ tkn triggerbinding describe mybinding -n myspace

triggerbinding list

列出 TriggerBindings。

示例：列出命名空间中的所有 TriggerBindings
$ tkn triggerbinding list -n myspace

triggertemplate

管理 TriggerTemplates。

示例：显示 TriggerTemplate 帮助
$ tkn triggertemplate -h

triggertemplate delete

删除 TriggerTemplate。

示例：删除命名空间中的mytemplate1和mytemplate2 TriggerTemplates
$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`

triggertemplate describe

描述 TriggerTemplate。

示例：描述命名空间中的mytemplate TriggerTemplate
$ tkn triggertemplate describe mytemplate -n `myspace`

triggertemplate list

列出 TriggerTemplates。

示例：列出命名空间中的所有 TriggerTemplates
$ tkn triggertemplate list -n myspace

clustertriggerbinding

管理 ClusterTriggerBindings。

示例：显示 ClusterTriggerBindings 帮助
$ tkn clustertriggerbinding -h

clustertriggerbinding delete

删除 ClusterTriggerBinding。

示例：删除myclusterbinding1和myclusterbinding2 ClusterTriggerBindings
$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2

clustertriggerbinding describe

描述 ClusterTriggerBinding。

示例：描述myclusterbinding ClusterTriggerBinding
$ tkn clustertriggerbinding describe myclusterbinding

clustertriggerbinding list

列出 ClusterTriggerBindings。

示例：列出所有 ClusterTriggerBindings
$ tkn clustertriggerbinding list

Hub 交互命令

与 Tekton Hub 交互，例如任务和流水线资源。

hub

与 Hub 交互。

示例：显示帮助
$ tkn hub -h
示例：与 Hub API 服务器交互
$ tkn hub --api-server https://api.hub.tekton.dev

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

hub downgrade

降级已安装的资源。

示例：将mynamespace命名空间中的mytask任务降级到其旧版本
$ tkn hub downgrade task mytask --to version -n mynamespace

hub get

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

示例：从tekton目录获取特定版本的myresource流水线或任务的清单
$ tkn hub get [pipeline | task] myresource --from tekton --version version

hub info

显示有关资源的信息，包括其名称、类型、目录和版本。

示例：显示tekton目录中特定版本的mytask任务的信息
$ tkn hub info task mytask --from tekton --version version

hub install

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

示例：将tekton目录中特定版本的mytask任务安装到mynamespace命名空间
$ tkn hub install task mytask --from tekton --version version -n mynamespace

hub reinstall

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

示例：将tekton目录中特定版本的mytask任务重新安装到mynamespace命名空间
$ tkn hub reinstall task mytask --from tekton --version version -n mynamespace

通过名称、类型和标签的组合搜索资源。

示例：搜索带有标签cli的资源
$ tkn hub search --tags cli

hub upgrade

升级已安装的资源。

示例：将mynamespace命名空间中已安装的mytask任务升级到新版本
$ tkn hub upgrade task mytask --to version -n mynamespace