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 是 bashzsh

示例: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 create

创建一个 Pipeline

示例: 在命名空间中创建一个由 mypipeline.yaml 文件定义的 Pipeline

$ tkn pipeline create -f mypipeline.yaml -n myspace

5.3.4.3. pipeline delete

删除 Pipeline

示例: 从命名空间中删除 mypipeline Pipeline

$ tkn pipeline delete mypipeline -n myspace

5.3.4.4. pipeline describe

描述管道。

示例: 描述 mypipeline Pipeline

$ tkn pipeline describe mypipeline

5.3.4.5. pipeline list

列出管道。

示例: 显示 Pipelines 列表

$ tkn pipeline list

5.3.4.6. pipeline logs

显示特定 Pipeline 的 Pipeline 日志。

示例:mypipeline Pipeline 的 Stream live 日志

$ tkn pipeline logs -f mypipeline

5.3.4.7. pipeline start

运行 Pipeline。

示例: 启动 mypipeline Pipeline

$ tkn pipeline start mypipeline

5.3.5. PipelineRun 命令

5.3.5.1. pipelinerun

管理 PipelineRuns。

示例: 显示帮助信息

$ tkn pipelinerun -h

5.3.5.2. pipelinerun cancel

取消 PipelineRun。

示例:从命名空间中取消 mypipelinerun PipelineRun

$ tkn pipelinerun cancel mypipelinerun -n myspace

5.3.5.3. pipelinerun delete

删除 PipelineRun。

示例: 从命名空间中删除 PipelineRuns

$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace

5.3.5.4. pipelinerun describe

描述 PipelineRun。

示例:描述命名空间中的 mypipelinerun PipelineRun

tkn pipelinerun describe mypipelinerun -n myspace

5.3.5.5. pipelinerun list

列出 PipelineRuns。

示例: 显示命名空间中的 PipelineRuns 列表

$ tkn pipelinerun list -n myspace

5.3.5.6. pipelinerun logs

显示一个 PipelineRun 的日志。

示例:显示 mypipelinerun PipelineRun 的日志,包括命名空间中的所有任务和步骤

$ tkn pipelinerun logs mypipelinerun -a -n myspace

5.3.6. 任务管理命令

5.3.6.1. task

管理任务。

示例: 显示帮助信息

$ tkn task -h

5.3.6.2. task create

创建任务。

示例: 在命名空间中创建 mytask.yaml 文件定义的任务

$ tkn task create -f mytask.yaml -n myspace

5.3.6.3. task delete

删除一个任务。

示例:从命令空间中删除 mytask1mytask2 任务

$ tkn task delete mytask1 mytask2 -n myspace

5.3.6.4. task describe

描述一个任务。

示例:描述一个命名空间中的 mytask 任务

$ tkn task describe mytask -n myspace

5.3.6.5. task list

列出任务。

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

$ tkn task list -n myspace

5.3.6.6. task logs

显示任务日志。

示例:显示 mytask 任务的 mytaskrun TaskRun 的日志

$ tkn task logs mytask mytaskrun -n myspace

5.3.6.7. task start

启动一个任务。

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

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

5.3.7. TaskRun 命令

5.3.7.1. taskrun

管理 TaskRuns。

示例: 显示帮助信息

$ tkn taskrun -h

5.3.7.2. taskrun cancel

取消 TaskRun。

示例:从一个命名空间中取消 mytaskrun TaskRun

$ tkn taskrun cancel mytaskrun -n myspace

5.3.7.3. taskrun delete

删除一个 TaskRun。

示例:从一个命名空间中删除 mytaskrun1mytaskrun2 TaskRuns

$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace

5.3.7.4. taskrun describe

描述 TaskRun。

示例:描述命名空间中的 mytaskrun TaskRun

$ tkn taskrun describe mytaskrun -n myspace

5.3.7.5. taskrun list

列出 TaskRuns。

示例: 列出命名空间中的所有 TaskRuns

$ tkn taskrun list -n myspace

5.3.7.6. taskrun logs

显示 TaskRun 日志。

示例: 显示命名空间中 mytaskrun TaskRun 的实时日志

$ 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 资源。

示例:在一个命名空间中创建由 myresource.yaml 文件定义的 Pipeline 资源

$ tkn resource create -f myresource.yaml -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 管理命令

5.3.10.1. clustertask

管理 ClusterTasks。

示例: 显示帮助信息

$ tkn clustertask --help

5.3.10.2. clustertask delete

删除集群中的 ClusterTask 资源。

示例: 删除 mytask1mytask2 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。

示例:删除命令空间中的 mylistener1mylistener2 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. triggerbinding

管理 TriggerBindings。

示例: 显示 TriggerBindings 帮助信息

$ tkn triggerbinding -h

5.3.11.6. triggerbinding delete

删除 TriggerBinding。

示例:删除一个命名空间中的 mybinding1mybinding2 TriggerBindings

$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace

5.3.11.7. triggerbinding describe

描述 TriggerBinding。

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

$ tkn triggerbinding describe mybinding -n myspace

5.3.11.8. triggerbinding list

列出 TriggerBindings。

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

$ tkn triggerbinding list -n myspace

5.3.11.9. triggertemplate

管理 TriggerTemplates。

示例: 显示 TriggerTemplate 帮助

$ tkn triggertemplate -h

5.3.11.10. triggertemplate delete

删除 TriggerTemplate。

示例:删除命名空间中的 mytemplate1mytemplate2 TriggerTemplates

$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`

5.3.11.11. triggertemplate describe

描述 TriggerTemplate。

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

$ tkn triggertemplate describe mytemplate -n `myspace`

5.3.11.12. triggertemplate list

列出 TriggerTemplates。

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

$ tkn triggertemplate list -n myspace

5.3.11.13. clustertriggerbinding

管理 ClusterTriggerBindings。

示例: 显示 ClusterTriggerBindings 帮助信息

$ tkn clustertriggerbinding -h

5.3.11.14. clustertriggerbinding delete

删除 ClusterTriggerBinding。

示例: 删除 myclusterbinding1myclusterbinding2 ClusterTriggerBindings

$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2

5.3.11.15. clustertriggerbinding describe

描述 ClusterTriggerBinding。

示例: 描述 myclusterbinding ClusterTriggerBinding

$ tkn clustertriggerbinding describe myclusterbinding

5.3.11.16. clustertriggerbinding list

列出 ClusterTriggerBindings。

示例: 列出所有 ClusterTriggerBindings

$ tkn clustertriggerbinding list