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
$ tkn5.3.3.2. completion [shell]
						インタラクティブな補完を提供するために評価する必要があるシェル補完コードを出力します。サポートされるシェルは bash および zsh です。
					
例: bash シェルの補完コード
tkn completion bash
$ tkn completion bash5.3.3.3. version
						tkn CLI のバージョン情報を出力します。
					
例: tkn バージョンを確認する
tkn version
$ tkn version5.3.4. Pipelines 管理コマンド
5.3.4.1. pipeline
パイプラインを管理します。
例: ヘルプを表示する
tkn pipeline --help
$ tkn pipeline --help5.3.4.2. pipeline delete
パイプラインを削除します。
例: namespace から mypipeline パイプラインを削除します。
tkn pipeline delete mypipeline -n myspace
$ tkn pipeline delete mypipeline -n myspace5.3.4.3. pipeline describe
パイプラインを記述します。
例: mypipeline パイプラインを記述します。
tkn pipeline describe mypipeline
$ tkn pipeline describe mypipeline5.3.4.4. pipeline list
パイプラインのリストを表示します。
例: パイプラインのリストを表示する
tkn pipeline list
$ tkn pipeline list5.3.4.5. pipeline logs
特定のパイプラインのログを表示します。
例: mypipeline パイプラインのライブログのストリーミング
tkn pipeline logs -f mypipeline
$ tkn pipeline logs -f mypipeline5.3.4.6. pipeline start
パイプラインを起動します。
例: mypipeline パイプラインを起動します。
tkn pipeline start mypipeline
$ tkn pipeline start mypipeline5.3.5. パイプラインの実行コマンド
5.3.5.1. pipelinerun
パイプラインの実行を管理します。
例: ヘルプを表示する
tkn pipelinerun -h
$ tkn pipelinerun -h5.3.5.2. pipelinerun cancel
パイプラインの実行をキャンセルします。
例: namespace からの mypipelinerun パイプラインの実行を取り消します。
tkn pipelinerun cancel mypipelinerun -n myspace
$ tkn pipelinerun cancel mypipelinerun -n myspace5.3.5.3. pipelinerun delete
パイプラインの実行を削除します。
例: namespace からパイプラインの実行を削除する
tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace例: 最近実行された 5 つのパイプラインの実行を除き、namespace からすべてのパイプラインの実行を削除する
tkn pipelinerun delete -n myspace --keep 5
$ tkn pipelinerun delete -n myspace --keep 5 - 1
- 5を、保持する最近実行されたパイプラインの実行の数に置き換えます。
例: すべての Pipeline を削除する
tkn pipelinerun delete --all
$ tkn pipelinerun delete --all
							Red Hat OpenShift Pipelines 1.6 以降では、tkn pipelinerun delete --all コマンドは、running 状態のリソースを削除しません。
						
5.3.5.4. pipelinerun describe
パイプラインの実行を記述します。
例: namespace での mypipelinerun パイプラインの実行を記述します。
tkn pipelinerun describe mypipelinerun -n myspace
$ tkn pipelinerun describe mypipelinerun -n myspace5.3.5.5. pipelinerun list
パイプラインの実行をリストします。
例: namespace でのパイプラインの実行のリストを表示する
tkn pipelinerun list -n myspace
$ tkn pipelinerun list -n myspace5.3.5.6. pipelinerun logs
パイプラインの実行のログを表示します。
例: namespace のすべてのタスクおよび手順を含む mypipelinerun パイプラインの実行のログを表示します。
tkn pipelinerun logs mypipelinerun -a -n myspace
$ tkn pipelinerun logs mypipelinerun -a -n myspace5.3.6. タスク管理コマンド
5.3.6.1. task
タスクを管理します。
例: ヘルプを表示する
tkn task -h
$ tkn task -h5.3.6.2. task delete
タスクを削除します。
例: namespace からの mytask1 および mytask2 タスクを削除します。
tkn task delete mytask1 mytask2 -n myspace
$ tkn task delete mytask1 mytask2 -n myspace5.3.6.3. task describe
タスクを記述します。
例: namespace の mytask タスクを記述します。
tkn task describe mytask -n myspace
$ tkn task describe mytask -n myspace5.3.6.4. task list
タスクをリストします。
例: namespace のすべてのタスクをリスト表示します。
tkn task list -n myspace
$ tkn task list -n myspace5.3.6.5. task logs
タスクログを表示します。
例: mytask タスクの mytaskrun タスク実行のログを表示します。
tkn task logs mytask mytaskrun -n myspace
$ tkn task logs mytask mytaskrun -n myspace5.3.6.6. task start
タスクを開始します。
例: namespace の mytask タスクを開始します。
tkn task start mytask -s <ServiceAccountName> -n myspace
$ tkn task start mytask -s <ServiceAccountName> -n myspace5.3.7. タスク実行コマンド
5.3.7.1. taskrun
タスク実行を管理します。
例: ヘルプを表示する
tkn taskrun -h
$ tkn taskrun -h5.3.7.2. taskrun cancel
タスク実行をキャンセルします。
例: namespace からの mytaskrun タスク実行を取り消します。
tkn taskrun cancel mytaskrun -n myspace
$ tkn taskrun cancel mytaskrun -n myspace5.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を、保持する最近実行したタスク実行の数に置き換えます。
5.3.7.4. taskrun describe
タスク実行を記述します。
例: namespace での mytaskrun タスク実行を記述します。
tkn taskrun describe mytaskrun -n myspace
$ tkn taskrun describe mytaskrun -n myspace5.3.7.5. taskrun list
タスク実行をリストします。
例: namespace のすべてのタスク実行をリストする
tkn taskrun list -n myspace
$ tkn taskrun list -n myspace5.3.7.6. taskrun logs
タスク実行ログを表示します。
例: namespace での mytaskrun タスク実行のライブログを表示します。
tkn taskrun logs -f mytaskrun -n myspace
$ tkn taskrun logs -f mytaskrun -n myspace5.3.8. 条件管理コマンド
5.3.8.1. condition
条件を管理します。
例: ヘルプを表示する
tkn condition --help
$ tkn condition --help5.3.8.2. condition delete
条件を削除します。
例: namespace からの mycondition1 条件の削除
tkn condition delete mycondition1 -n myspace
$ tkn condition delete mycondition1 -n myspace5.3.8.3. condition describe
条件を記述します。
例: namespace での mycondition1 条件の記述
tkn condition describe mycondition1 -n myspace
$ tkn condition describe mycondition1 -n myspace5.3.8.4. condition list
条件をリスト表示します。
例: namespace での条件のリスト表示
tkn condition list -n myspace
$ tkn condition list -n myspace5.3.9. Pipeline リソース管理コマンド
5.3.9.1. resource
Pipeline リソースを管理します。
例: ヘルプを表示する
tkn resource -h
$ tkn resource -h5.3.9.2. resource create
Pipeline リソースを作成します。
例: namespace に Pipeline リソースを作成する
tkn resource create -n myspace
$ tkn resource create -n myspaceこれは、リソースの名前、リソースのタイプ、およびリソースのタイプに基づく値の入力を要求するインタラクティブなコマンドです。
5.3.9.3. resource delete
Pipeline リソースを削除します。
例: namespace から myresource Pipeline リソースを削除する
tkn resource delete myresource -n myspace
$ tkn resource delete myresource -n myspace5.3.9.4. resource describe
Pipeline リソースを記述します。
例: myresource Pipeline リソースを記述する
tkn resource describe myresource -n myspace
$ tkn resource describe myresource -n myspace5.3.9.5. resource list
Pipeline リソースをリストします。
例: namespace のすべての Pipeline リソースのリスト表示
tkn resource list -n myspace
$ tkn resource list -n myspace5.3.10. ClusterTask 管理コマンド
						Red Hat OpenShift Pipelines 1.10 では、tkn コマンドラインユーティリティーの ClusterTask 機能が非推奨となり、今後のリリースで削除される予定です。
					
5.3.10.1. clustertask
ClusterTask を管理します。
例: ヘルプを表示する
tkn clustertask --help
$ tkn clustertask --help5.3.10.2. clustertask delete
クラスターの ClusterTask リソースを削除します。
例: mytask1 および mytask2 ClusterTask の削除
tkn clustertask delete mytask1 mytask2
$ tkn clustertask delete mytask1 mytask25.3.10.3. clustertask describe
ClusterTask を記述します。
例: mytask ClusterTask の記述
tkn clustertask describe mytask1
$ tkn clustertask describe mytask15.3.10.4. clustertask list
ClusterTask をリスト表示します。
例: ClusterTask のリスト表示
tkn clustertask list
$ tkn clustertask list5.3.10.5. clustertask start
ClusterTask を開始します。
例: mytask ClusterTask の開始
tkn clustertask start mytask
$ tkn clustertask start mytask5.3.11. 管理コマンドのトリガー
5.3.11.1. eventlistener
EventListener を管理します。
例: ヘルプを表示する
tkn eventlistener -h
$ tkn eventlistener -h5.3.11.2. eventlistener delete
EventListener を削除します。
例: namespace の mylistener1 および mylistener2 EventListener を削除する
tkn eventlistener delete mylistener1 mylistener2 -n myspace
$ tkn eventlistener delete mylistener1 mylistener2 -n myspace5.3.11.3. eventlistener describe
EventListener を記述します。
例: namespace の mylistener EventListener を記述する
tkn eventlistener describe mylistener -n myspace
$ tkn eventlistener describe mylistener -n myspace5.3.11.4. eventlistener list
EventListener をリストします。
例: namespace のすべての EventListener をリストする
tkn eventlistener list -n myspace
$ tkn eventlistener list -n myspace5.3.11.5. eventlistener ログ
EventListener のログを表示します。
例: namespace に mylistener EventListener のログを表示する
tkn eventlistener logs mylistener -n myspace
$ tkn eventlistener logs mylistener -n myspace5.3.11.6. triggerbinding
TriggerBinding を管理します。
例: TriggerBindings ヘルプを表示する
tkn triggerbinding -h
$ tkn triggerbinding -h5.3.11.7. triggerbinding delete
TriggerBinding を削除します。
例: namespace の mybinding1 および mybinding2 TriggerBinding を削除する
tkn triggerbinding delete mybinding1 mybinding2 -n myspace
$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace5.3.11.8. triggerbinding describe
TriggerBinding を記述します。
例: namespace の mybinding TriggerBinding を記述する
tkn triggerbinding describe mybinding -n myspace
$ tkn triggerbinding describe mybinding -n myspace5.3.11.9. triggerbinding list
TriggerBinding をリストします。
例: namespace のすべての TriggerBinding をリストする
tkn triggerbinding list -n myspace
$ tkn triggerbinding list -n myspace5.3.11.10. triggertemplate
TriggerTemplate を管理します。
例: TriggerTemplate ヘルプを表示する
tkn triggertemplate -h
$ tkn triggertemplate -h5.3.11.11. triggertemplate delete
TriggerTemplate を削除します。
例: namespace の mytemplate1 および mytemplate2 TriggerTemplate を削除する
tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`5.3.11.12. triggertemplate describe
TriggerTemplate を記述します。
例: namespace の mytemplate TriggerTemplate を記述する
tkn triggertemplate describe mytemplate -n `myspace`
$ tkn triggertemplate describe mytemplate -n `myspace`5.3.11.13. triggertemplate list
TriggerTemplate をリストします。
例: namespace のすべての TriggerTemplate をリストする
tkn triggertemplate list -n myspace
$ tkn triggertemplate list -n myspace5.3.11.14. clustertriggerbinding
ClusterTriggerBinding を管理します。
例: ClusterTriggerBinding のヘルプを表示する
tkn clustertriggerbinding -h
$ tkn clustertriggerbinding -h5.3.11.15. clustertriggerbinding delete
ClusterTriggerBinding を削除します。
例: myclusterbinding1 および myclusterbinding2 ClusterTriggerBinding を削除する
tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding25.3.11.16. clustertriggerbinding describe
ClusterTriggerBinding を記述します。
例: myclusterbinding ClusterTriggerBinding を記述する
tkn clustertriggerbinding describe myclusterbinding
$ tkn clustertriggerbinding describe myclusterbinding5.3.11.17. clustertriggerbinding list
ClusterTriggerBinding のリストを表示します。
例: すべての ClusterTriggerBinding をリストする
tkn clustertriggerbinding list
$ tkn clustertriggerbinding list5.3.12. hub 対話コマンド
タスクやパイプラインなど、リソースの Tekton Hub と対話します。
5.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 を実行します。
						
5.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 mynamespace5.3.12.3. hub get
名前、種類、カタログ、およびバージョン別に、リソースマニフェストを取得します。
例: tekton カタログからの特定バージョンの myresource パイプラインまたはタスクのマニフェストを取得する
tkn hub get [pipeline | task] myresource --from tekton --version version
$ tkn hub get [pipeline | task] myresource --from tekton --version version5.3.12.4. hub info
名前、種類、カタログ、およびバージョン別に、リソースに関する情報を表示します。
例: tekton カタログからの特定バージョンの mytask タスクに関する情報を表示する
tkn hub info task mytask --from tekton --version version
$ tkn hub info task mytask --from tekton --version version5.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 mynamespace5.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 mynamespace5.3.12.7. hub search
名前、種類、およびタグの組み合わせでリソースを検索します。
例: タグ cli でリソースを検索する
tkn hub search --tags cli
$ tkn hub search --tags cli5.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