6.3. OpenShift Pipelines tkn リファレンス
このセクションでは、基本的な tkn
CLI コマンドのリストを紹介します。
6.3.1. 基本的な構文 リンクのコピーリンクがクリップボードにコピーされました!
tkn [command or options] [arguments…]
6.3.2. グローバルオプション リンクのコピーリンクがクリップボードにコピーされました!
--help, -h
6.3.3. ユーティリティーコマンド リンクのコピーリンクがクリップボードにコピーされました!
6.3.3.1. tkn リンクのコピーリンクがクリップボードにコピーされました!
tkn
CLI の親コマンド。
例: すべてのオプションを表示する
tkn
$ tkn
6.3.3.2. completion [shell] リンクのコピーリンクがクリップボードにコピーされました!
インタラクティブな補完を提供するために評価する必要があるシェル補完コードを出力します。サポートされるシェルは bash
および zsh
です。
例: bash
シェルの補完コード
tkn completion bash
$ tkn completion bash
6.3.3.3. version リンクのコピーリンクがクリップボードにコピーされました!
tkn
CLI のバージョン情報を出力します。
例: tkn
バージョンを確認する
tkn version
$ tkn version
6.3.4. Pipelines 管理コマンド リンクのコピーリンクがクリップボードにコピーされました!
6.3.4.1. パイプライン リンクのコピーリンクがクリップボードにコピーされました!
Pipeline を管理します。
例: ヘルプを表示する
tkn pipeline --help
$ tkn pipeline --help
6.3.4.2. pipeline delete リンクのコピーリンクがクリップボードにコピーされました!
Pipeline を削除します。
例: namespace から mypipeline
Pipeline を削除します。
tkn pipeline delete mypipeline -n myspace
$ tkn pipeline delete mypipeline -n myspace
6.3.4.3. pipeline describe リンクのコピーリンクがクリップボードにコピーされました!
Pipeline を記述します。
例: mypipeline
Pipeline を記述します。
tkn pipeline describe mypipeline
$ tkn pipeline describe mypipeline
6.3.4.4. pipeline list リンクのコピーリンクがクリップボードにコピーされました!
Pipeline のリストを表示します。
例: Pipeline のリストを表示する
tkn pipeline list
$ tkn pipeline list
6.3.4.5. pipeline logs リンクのコピーリンクがクリップボードにコピーされました!
特定の Pipeline のログを表示します。
例: mypipeline
Pipeline のライブログのストリーミング
tkn pipeline logs -f mypipeline
$ tkn pipeline logs -f mypipeline
6.3.4.6. pipeline start リンクのコピーリンクがクリップボードにコピーされました!
Pipeline を起動します。
例: mypipeline
Pipeline を起動します。
tkn pipeline start mypipeline
$ tkn pipeline start mypipeline
6.3.5. Pipeline 実行コマンド リンクのコピーリンクがクリップボードにコピーされました!
6.3.5.1. pipelinerun リンクのコピーリンクがクリップボードにコピーされました!
Pipeline 実行を管理します。
例: ヘルプを表示する
tkn pipelinerun -h
$ tkn pipelinerun -h
6.3.5.2. pipelinerun cancel リンクのコピーリンクがクリップボードにコピーされました!
Pipeline 実行をキャンセルします。
例: namespace からの mypipelinerun
Pipeline 実行を取り消します。
tkn pipelinerun cancel mypipelinerun -n myspace
$ tkn pipelinerun cancel mypipelinerun -n myspace
6.3.5.3. pipelinerun delete リンクのコピーリンクがクリップボードにコピーされました!
Pipeline 実行を削除します。
例: namespace からの Pipeline 実行を削除する
tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
例: 最近実行された 5 つの Pipeline 実行を除き、namespace からすべての Pipeline 実行を削除する
tkn pipelinerun delete -n myspace --keep 5
$ tkn pipelinerun delete -n myspace --keep 5
- 1
5
を、保持する最近実行された Pipeline 実行の数に置き換えます。
例: すべての Pipeline を削除する
tkn pipelinerun delete --all
$ tkn pipelinerun delete --all
Red Hat OpenShift Pipelines 1.6 以降では、tkn pipelinerun delete --all
コマンドは、running 状態のリソースを削除しません。
6.3.5.4. pipelinerun describe リンクのコピーリンクがクリップボードにコピーされました!
Pipeline 実行を記述します。
例: namespace での mypipelinerun
Pipeline 実行を記述します。
tkn pipelinerun describe mypipelinerun -n myspace
$ tkn pipelinerun describe mypipelinerun -n myspace
6.3.5.5. pipelinerun list リンクのコピーリンクがクリップボードにコピーされました!
Pipeline 実行をリストします。
例: namespace での Pipeline 実行のリストを表示する
tkn pipelinerun list -n myspace
$ tkn pipelinerun list -n myspace
6.3.5.6. pipelinerun logs リンクのコピーリンクがクリップボードにコピーされました!
Pipeline 実行のログを表示します。
例: namespace のすべてのタスクおよび手順を含む mypipelinerun
Pipeline 実行のログを表示します。
tkn pipelinerun logs mypipelinerun -a -n myspace
$ tkn pipelinerun logs mypipelinerun -a -n myspace
6.3.6. タスク管理コマンド リンクのコピーリンクがクリップボードにコピーされました!
6.3.6.1. task リンクのコピーリンクがクリップボードにコピーされました!
タスクを管理します。
例: ヘルプを表示する
tkn task -h
$ tkn task -h
6.3.6.2. task delete リンクのコピーリンクがクリップボードにコピーされました!
タスクを削除します。
例: namespace からの mytask1
および mytask2
タスクを削除します。
tkn task delete mytask1 mytask2 -n myspace
$ tkn task delete mytask1 mytask2 -n myspace
6.3.6.3. task describe リンクのコピーリンクがクリップボードにコピーされました!
タスクを記述します。
例: namespace の mytask
タスクを記述します。
tkn task describe mytask -n myspace
$ tkn task describe mytask -n myspace
6.3.6.4. task list リンクのコピーリンクがクリップボードにコピーされました!
タスクをリストします。
例: namespace のすべてのタスクをリスト表示します。
tkn task list -n myspace
$ tkn task list -n myspace
6.3.6.5. task logs リンクのコピーリンクがクリップボードにコピーされました!
タスクログを表示します。
例: mytask
タスクの mytaskrun
タスク実行のログを表示します。
tkn task logs mytask mytaskrun -n myspace
$ tkn task logs mytask mytaskrun -n myspace
6.3.6.6. task start リンクのコピーリンクがクリップボードにコピーされました!
タスクを開始します。
例: namespace の mytask
タスクを開始します。
tkn task start mytask -s <ServiceAccountName> -n myspace
$ tkn task start mytask -s <ServiceAccountName> -n myspace
6.3.7. タスク実行コマンド リンクのコピーリンクがクリップボードにコピーされました!
6.3.7.1. taskrun リンクのコピーリンクがクリップボードにコピーされました!
タスク実行を管理します。
例: ヘルプを表示する
tkn taskrun -h
$ tkn taskrun -h
6.3.7.2. taskrun cancel リンクのコピーリンクがクリップボードにコピーされました!
タスク実行をキャンセルします。
例: namespace からの mytaskrun
タスク実行を取り消します。
tkn taskrun cancel mytaskrun -n myspace
$ tkn taskrun cancel mytaskrun -n myspace
6.3.7.3. taskrun delete リンクのコピーリンクがクリップボードにコピーされました!
TaskRun を削除します。
例: namespace からの mytaskrun1
および mytaskrun2
タスク実行を削除します。
tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
例: namespace から最近実行された 5 つのタスク以外のすべてのタスクを削除します。
tkn taskrun delete -n myspace --keep 5
$ tkn taskrun delete -n myspace --keep 5
- 1
5
を、保持する最近実行したタスク実行の数に置き換えます。
6.3.7.4. taskrun describe リンクのコピーリンクがクリップボードにコピーされました!
タスク実行を記述します。
例: namespace での mytaskrun
タスク実行を記述します。
tkn taskrun describe mytaskrun -n myspace
$ tkn taskrun describe mytaskrun -n myspace
6.3.7.5. taskrun list リンクのコピーリンクがクリップボードにコピーされました!
タスク実行をリストします。
例: namespace のすべてのタスク実行をリストする
tkn taskrun list -n myspace
$ tkn taskrun list -n myspace
6.3.7.6. taskrun logs リンクのコピーリンクがクリップボードにコピーされました!
タスク実行ログを表示します。
例: namespace での mytaskrun
タスク実行のライブログを表示します。
tkn taskrun logs -f mytaskrun -n myspace
$ tkn taskrun logs -f mytaskrun -n myspace
6.3.8. 条件管理コマンド リンクのコピーリンクがクリップボードにコピーされました!
6.3.8.1. condition リンクのコピーリンクがクリップボードにコピーされました!
条件を管理します。
例: ヘルプを表示する
tkn condition --help
$ tkn condition --help
6.3.8.2. condition delete リンクのコピーリンクがクリップボードにコピーされました!
条件を削除します。
例: namespace からの mycondition1
条件の削除
tkn condition delete mycondition1 -n myspace
$ tkn condition delete mycondition1 -n myspace
6.3.8.3. condition describe リンクのコピーリンクがクリップボードにコピーされました!
条件を記述します。
例: namespace での mycondition1
条件の記述
tkn condition describe mycondition1 -n myspace
$ tkn condition describe mycondition1 -n myspace
6.3.8.4. condition list リンクのコピーリンクがクリップボードにコピーされました!
条件をリスト表示します。
例: namespace での条件のリスト表示
tkn condition list -n myspace
$ tkn condition list -n myspace
6.3.9. Pipeline リソース管理コマンド リンクのコピーリンクがクリップボードにコピーされました!
6.3.9.1. resource リンクのコピーリンクがクリップボードにコピーされました!
Pipeline リソースを管理します。
例: ヘルプを表示する
tkn resource -h
$ tkn resource -h
6.3.9.2. resource create リンクのコピーリンクがクリップボードにコピーされました!
Pipeline リソースを作成します。
例: namespace に Pipeline リソースを作成する
tkn resource create -n myspace
$ tkn resource create -n myspace
これは、リソースの名前、リソースのタイプ、およびリソースのタイプに基づく値の入力を要求するインタラクティブなコマンドです。
6.3.9.3. resource delete リンクのコピーリンクがクリップボードにコピーされました!
Pipeline リソースを削除します。
例: namespace から myresource
Pipeline リソースを削除する
tkn resource delete myresource -n myspace
$ tkn resource delete myresource -n myspace
6.3.9.4. resource describe リンクのコピーリンクがクリップボードにコピーされました!
Pipeline リソースを記述します。
例: myresource
Pipeline リソースを記述する
tkn resource describe myresource -n myspace
$ tkn resource describe myresource -n myspace
6.3.9.5. resource list リンクのコピーリンクがクリップボードにコピーされました!
Pipeline リソースをリストします。
例: namespace のすべての Pipeline リソースのリスト表示
tkn resource list -n myspace
$ tkn resource list -n myspace
6.3.10. ClusterTask 管理コマンド リンクのコピーリンクがクリップボードにコピーされました!
Red Hat OpenShift Pipelines 1.10 では、tkn
コマンドラインユーティリティーの ClusterTask 機能が非推奨となり、今後のリリースで削除される予定です。
6.3.10.1. clustertask リンクのコピーリンクがクリップボードにコピーされました!
ClusterTask を管理します。
例: ヘルプを表示する
tkn clustertask --help
$ tkn clustertask --help
6.3.10.2. clustertask delete リンクのコピーリンクがクリップボードにコピーされました!
クラスターの ClusterTask リソースを削除します。
例: mytask1
および mytask2
ClusterTask の削除
tkn clustertask delete mytask1 mytask2
$ tkn clustertask delete mytask1 mytask2
6.3.10.3. clustertask describe リンクのコピーリンクがクリップボードにコピーされました!
ClusterTask を記述します。
例: mytask
ClusterTask の記述
tkn clustertask describe mytask1
$ tkn clustertask describe mytask1
6.3.10.4. clustertask list リンクのコピーリンクがクリップボードにコピーされました!
ClusterTask をリスト表示します。
例: ClusterTask のリスト表示
tkn clustertask list
$ tkn clustertask list
6.3.10.5. clustertask start リンクのコピーリンクがクリップボードにコピーされました!
ClusterTask を開始します。
例: mytask
ClusterTask の開始
tkn clustertask start mytask
$ tkn clustertask start mytask
6.3.11. 管理コマンドのトリガー リンクのコピーリンクがクリップボードにコピーされました!
6.3.11.1. eventlistener リンクのコピーリンクがクリップボードにコピーされました!
EventListener を管理します。
例: ヘルプを表示する
tkn eventlistener -h
$ tkn eventlistener -h
6.3.11.2. eventlistener delete リンクのコピーリンクがクリップボードにコピーされました!
EventListener を削除します。
例: namespace の mylistener1
および mylistener2
EventListener を削除する
tkn eventlistener delete mylistener1 mylistener2 -n myspace
$ tkn eventlistener delete mylistener1 mylistener2 -n myspace
6.3.11.3. eventlistener describe リンクのコピーリンクがクリップボードにコピーされました!
EventListener を記述します。
例: namespace の mylistener
EventListener を記述する
tkn eventlistener describe mylistener -n myspace
$ tkn eventlistener describe mylistener -n myspace
6.3.11.4. eventlistener list リンクのコピーリンクがクリップボードにコピーされました!
EventListener をリストします。
例: namespace のすべての EventListener をリストする
tkn eventlistener list -n myspace
$ tkn eventlistener list -n myspace
6.3.11.5. eventlistener ログ リンクのコピーリンクがクリップボードにコピーされました!
EventListener のログを表示します。
例: namespace に mylistener
EventListener のログを表示する
tkn eventlistener logs mylistener -n myspace
$ tkn eventlistener logs mylistener -n myspace
6.3.11.6. triggerbinding リンクのコピーリンクがクリップボードにコピーされました!
TriggerBinding を管理します。
例: TriggerBindings ヘルプを表示する
tkn triggerbinding -h
$ tkn triggerbinding -h
6.3.11.7. triggerbinding delete リンクのコピーリンクがクリップボードにコピーされました!
TriggerBinding を削除します。
例: namespace の mybinding1
および mybinding2
TriggerBinding を削除する
tkn triggerbinding delete mybinding1 mybinding2 -n myspace
$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace
6.3.11.8. triggerbinding describe リンクのコピーリンクがクリップボードにコピーされました!
TriggerBinding を記述します。
例: namespace の mybinding
TriggerBinding を記述する
tkn triggerbinding describe mybinding -n myspace
$ tkn triggerbinding describe mybinding -n myspace
6.3.11.9. triggerbinding list リンクのコピーリンクがクリップボードにコピーされました!
TriggerBinding をリストします。
例: namespace のすべての TriggerBinding をリストする
tkn triggerbinding list -n myspace
$ tkn triggerbinding list -n myspace
6.3.11.10. triggertemplate リンクのコピーリンクがクリップボードにコピーされました!
TriggerTemplate を管理します。
例: TriggerTemplate ヘルプを表示する
tkn triggertemplate -h
$ tkn triggertemplate -h
6.3.11.11. triggertemplate delete リンクのコピーリンクがクリップボードにコピーされました!
TriggerTemplate を削除します。
例: namespace の mytemplate1
および mytemplate2
TriggerTemplate を削除する
tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
6.3.11.12. triggertemplate describe リンクのコピーリンクがクリップボードにコピーされました!
TriggerTemplate を記述します。
例: namespace の mytemplate
TriggerTemplate を記述する
tkn triggertemplate describe mytemplate -n `myspace`
$ tkn triggertemplate describe mytemplate -n `myspace`
6.3.11.13. triggertemplate list リンクのコピーリンクがクリップボードにコピーされました!
TriggerTemplate をリストします。
例: namespace のすべての TriggerTemplate をリストする
tkn triggertemplate list -n myspace
$ tkn triggertemplate list -n myspace
6.3.11.14. clustertriggerbinding リンクのコピーリンクがクリップボードにコピーされました!
ClusterTriggerBinding を管理します。
例: ClusterTriggerBinding のヘルプを表示する
tkn clustertriggerbinding -h
$ tkn clustertriggerbinding -h
6.3.11.15. clustertriggerbinding delete リンクのコピーリンクがクリップボードにコピーされました!
ClusterTriggerBinding を削除します。
例: myclusterbinding1
および myclusterbinding2
ClusterTriggerBinding を削除する
tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
6.3.11.16. clustertriggerbinding describe リンクのコピーリンクがクリップボードにコピーされました!
ClusterTriggerBinding を記述します。
例: myclusterbinding
ClusterTriggerBinding を記述する
tkn clustertriggerbinding describe myclusterbinding
$ tkn clustertriggerbinding describe myclusterbinding
6.3.11.17. clustertriggerbinding list リンクのコピーリンクがクリップボードにコピーされました!
ClusterTriggerBinding のリストを表示します。
例: すべての ClusterTriggerBinding をリストする
tkn clustertriggerbinding list
$ tkn clustertriggerbinding list
6.3.12. hub 対話コマンド リンクのコピーリンクがクリップボードにコピーされました!
タスクやパイプラインなど、リソースの Tekton Hub と対話します。
6.3.12.1. hub リンクのコピーリンクがクリップボードにコピーされました!
ハブと対話します。
例: ヘルプを表示する
tkn hub -h
$ tkn hub -h
例: ハブ API サーバーと対話する
tkn hub --api-server https://api.hub.tekton.dev
$ tkn hub --api-server https://api.hub.tekton.dev
それぞれの例で、対応するサブコマンドとフラグを取得するには、tkn hub <command> --help
を実行します。
6.3.12.2. hub downgrade リンクのコピーリンクがクリップボードにコピーされました!
インストール済みのリソースをダウングレードします。
例: mynamespace
namespace の mytask
タスクを古いバージョンにダウングレードします。
tkn hub downgrade task mytask --to version -n mynamespace
$ tkn hub downgrade task mytask --to version -n mynamespace
6.3.12.3. hub get リンクのコピーリンクがクリップボードにコピーされました!
名前、種類、カタログ、およびバージョン別に、リソースマニフェストを取得します。
例: tekton
カタログからの特定バージョンの myresource
Pipeline またはタスクのマニフェストを取得する
tkn hub get [pipeline | task] myresource --from tekton --version version
$ tkn hub get [pipeline | task] myresource --from tekton --version version
6.3.12.4. hub info リンクのコピーリンクがクリップボードにコピーされました!
名前、種類、カタログ、およびバージョン別に、リソースに関する情報を表示します。
例: tekton
カタログからの特定バージョンの mytask
タスクに関する情報を表示する
tkn hub info task mytask --from tekton --version version
$ tkn hub info task mytask --from tekton --version version
6.3.12.5. hub install リンクのコピーリンクがクリップボードにコピーされました!
種類、名前、バージョンごとにカタログからのリソースをインストールします。
例: mynamespace
namespace の tekton
カタログから mytask
タスクの特定バージョンをインストールする
tkn hub install task mytask --from tekton --version version -n mynamespace
$ tkn hub install task mytask --from tekton --version version -n mynamespace
6.3.12.6. hub reinstall リンクのコピーリンクがクリップボードにコピーされました!
種類および名前ごとにリソースを再インストールします。
例: mynamespace
namespace の tekton
カタログから mytask
タスクの特定バージョンを再インストールする
tkn hub reinstall task mytask --from tekton --version version -n mynamespace
$ tkn hub reinstall task mytask --from tekton --version version -n mynamespace
6.3.12.7. hub search リンクのコピーリンクがクリップボードにコピーされました!
名前、種類、およびタグの組み合わせでリソースを検索します。
例: タグ cli
でリソースを検索する
tkn hub search --tags cli
$ tkn hub search --tags cli
6.3.12.8. hub upgrade リンクのコピーリンクがクリップボードにコピーされました!
インストール済みのリソースをアップグレードします。
例: mynamespace
namespace のインストールされた mytask
タスクを新しいバージョンにアップグレードする
tkn hub upgrade task mytask --to version -n mynamespace
$ tkn hub upgrade task mytask --to version -n mynamespace