Red Hat SummitPipelines CLI (tkn) リファレンス
OpenShift Pipelines の tkn CLI リファレンス
概要
第1章 tkn のインストール
CLI ツールを使用して、ターミナルから Red Hat OpenShift Pipeline を管理します。この CLI ツールはさまざまなプラットフォームにインストールできます。
アーカイブと RPM の両方に、次の実行可能ファイルが含まれています。
-
tkn -
tkn-pac -
opc
opc CLI ツールを使用した Red Hat OpenShift Pipelines の実行は、テクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
1.1. Linux への Red Hat OpenShift Pipelines CLI のインストール
Linux ディストリビューションの場合は、CLI を tar.gz アーカイブとしてダウンロードできます。
手順
関連する CLI ツールをダウンロードします。
アーカイブを展開します。
$ tar xvzf <file>
-
tkn、tkn-pac、およびopcファイルの場所をPATH環境変数に追加します。 PATHを確認するには、以下のコマンドを実行します。$ echo $PATH
1.2. RPM を使用した Linux への Red Hat OpenShift Pipelines CLI のインストール
Red Hat Enterprise Linux (RHEL) バージョン 8 の場合は、Red Hat OpenShift Pipelines CLI を RPM としてインストールできます。
前提条件
- お使いの Red Hat アカウントに有効な OpenShift Container Platform サブスクリプションがある。
- ローカルシステムに root または sudo 権限がある。
手順
Red Hat Subscription Manager に登録します。
# subscription-manager register
最新のサブスクリプションデータをプルします。
# subscription-manager refresh
利用可能なサブスクリプションをリストします。
# subscription-manager list --available --matches '*pipelines*'
直前のコマンドの出力で、OpenShift Container Platform サブスクリプションのプール ID を見つけ、これを登録されたシステムにアタッチします。
# subscription-manager attach --pool=<pool_id>
Red Hat OpenShift Pipelines で必要なリポジトリーを有効にします。
Linux (x86_64, amd64)
# subscription-manager repos --enable="pipelines-1.18-for-rhel-8-x86_64-rpms"
Linux on IBM zSystems および IBM® LinuxONE (s390x)
# subscription-manager repos --enable="pipelines-1.18-for-rhel-8-s390x-rpms"
Linux on IBM Power (ppc64le)
# subscription-manager repos --enable="pipelines-1.18-for-rhel-8-ppc64le-rpms"
ARM 上の Linux (aarch64、arm64)
# subscription-manager repos --enable="pipelines-1.18-for-rhel-8-aarch64-rpms"
openshift-pipelines-clientパッケージをインストールします。# yum install openshift-pipelines-client
CLI のインストール後は、tkn コマンドを使用して利用できます。
$ tkn version
1.3. Windows への Red Hat OpenShift Pipelines CLI のインストール
Windows の場合は、CLI を zip アーカイブとしてダウンロードできます。
手順
- CLI ツール をダウンロードします。
- ZIP プログラムでアーカイブを展開します。
-
tkn、tkn-pac、およびopcファイルの場所をPATH環境変数に追加します。 PATHを確認するには、以下のコマンドを実行します。C:\> path
1.4. macOS への Red Hat OpenShift Pipelines CLI のインストール
macOS の場合は、CLI を tar.gz アーカイブとしてダウンロードできます。
手順
関連する CLI ツールをダウンロードします。
- アーカイブを解凍して解凍します。
-
tkn、tkn-pac、およびopcファイルの場所をPATH環境変数に追加します。 PATHを確認するには、以下のコマンドを実行します。$ echo $PATH
第2章 OpenShift Pipelines tkn CLI の設定
タブ補完を有効にするように Red Hat OpenShift Pipelines tkn CLI を設定します。
2.1. タブ補完の有効化
tkn CLI ツールのインストール後、タブ補完を有効にして tkn コマンドの自動補完を実行するか、Tab キーを押す際にオプションの提案が表示されるようにすることができます。
前提条件
-
tknCLI ツールがインストールされている。 -
ローカルシステムに
bash-completionがインストールされている。
手順
以下の手順では、Bash のタブ補完を有効にします。
Bash 補完コードをファイルに保存します。
$ tkn completion bash > tkn_bash_completion
ファイルを
/etc/bash_completion.d/にコピーします。$ sudo cp tkn_bash_completion /etc/bash_completion.d/
または、ファイルをローカルディレクトリーに保存してから、これを
.bashrcファイルから取得できるようにすることができます。
タブ補完は、新規ターミナルを開くと有効になります。
第3章 OpenShift Pipelines tkn リファレンス
このセクションでは、基本的な tkn CLI コマンドのリストを紹介します。
3.1. 基本的な構文
tkn [command or options] [arguments…]
3.2. グローバルオプション
--help, -h
3.3. ユーティリティーコマンド
3.3.1. tkn
tkn CLI の親コマンド。
例: すべてのオプションを表示する
$ tkn
3.3.2. completion [shell]
インタラクティブな補完を提供するために評価する必要があるシェル補完コードを出力します。サポートされるシェルは bash および zsh です。
例: bash シェルの補完コード
$ tkn completion bash
3.3.3. version
tkn CLI のバージョン情報を出力します。
例: tkn バージョンを確認する
$ tkn version
3.4. Pipelines 管理コマンド
3.4.1. パイプライン
Pipeline を管理します。
例: ヘルプを表示する
$ tkn pipeline --help
3.4.2. pipeline delete
Pipeline を削除します。
例: namespace からパイプラインを削除する
$ tkn pipeline delete <pipeline_name> -n <namespace_name>
3.4.3. pipeline describe
Pipeline を記述します。
例: パイプラインを説明する
$ tkn pipeline describe <pipeline_name>
3.4.4. pipeline list
Pipeline のリストを表示します。
例: Pipeline のリストを表示する
$ tkn pipeline list
3.4.5. pipeline logs
特定の Pipeline のログを表示します。
例: Pipeline のライブログをストリーミングする
$ tkn pipeline logs -f <pipeline_name>
3.4.6. pipeline start
Pipeline を起動します。
例: Pipeline を起動する
$ tkn pipeline start <pipeline_name>
3.5. Pipeline 実行コマンド
3.5.1. pipelinerun
Pipeline 実行を管理します。
例: ヘルプを表示する
$ tkn pipelinerun -h
3.5.2. pipelinerun cancel
Pipeline 実行をキャンセルします。
例: namespace からの Pipeline 実行をキャンセルする
$ tkn pipelinerun cancel <pipeline_run_name> -n <namespace_name>
3.5.3. pipelinerun delete
Pipeline 実行を削除します。
例: namespace からの Pipeline 実行を削除する
$ tkn pipelinerun delete <pipeline_run_name_1> <pipeline_run_name_2> -n <namespace_name>
例: 最近実行された 5 つの Pipeline 実行を除き、namespace からすべての Pipeline 実行を削除する
$ tkn pipelinerun delete -n <namespace_name> --keep 5 1
- 1
5を、保持する最近実行された Pipeline 実行の数に置き換えます。
例: すべての Pipeline を削除する
$ tkn pipelinerun delete --all
Red Hat OpenShift Pipelines 1.6 以降では、tkn pipelinerun delete --all コマンドは、running 状態のリソースを削除しません。
3.5.4. pipelinerun describe
Pipeline 実行を記述します。
例: namespace で実行する Pipeline を記述する
$ tkn pipelinerun describe <pipeline_run_name> -n <namespace_name>
3.5.5. pipelinerun list
Pipeline 実行をリストします。
例: namespace での Pipeline 実行のリストを表示する
$ tkn pipelinerun list -n <namespace_name>
3.5.6. pipelinerun logs
Pipeline 実行のログを表示します。
例: namespace 内のすべてのタスクとステップを含む Pipeline 実行のログを表示する
$ tkn pipelinerun logs <pipeline_run_name> -a -n <namespace_name>
3.6. タスク管理コマンド
3.6.1. task
タスクを管理します。
例: ヘルプを表示する
$ tkn task -h
3.6.2. task delete
タスクを削除します。
例: namespace からタスクを削除する
$ tkn task delete <task_name_1> <task_name_2> -n <namespace_name>
3.6.3. task describe
タスクを記述します。
例: namespace 内のタスクを記述する
$ tkn task describe <task_name> -n <namespace_name>
3.6.4. task list
タスクをリストします。
例: namespace のすべてのタスクをリストする
$ tkn task list -n <namespace_name>
3.6.5. task start
タスクを開始します。
例: namespace でタスクを開始する
$ tkn task start <task_name> -s <service_account_name> -n <namespace_name>
3.7. タスク実行コマンド
3.7.1. taskrun
タスク実行を管理します。
例: ヘルプを表示する
$ tkn taskrun -h
3.7.2. taskrun cancel
タスク実行をキャンセルします。
例: namespace から実行したタスクをキャンセルする
$ tkn taskrun cancel <task_run_name> -n <namespace_name>
3.7.3. taskrun delete
TaskRun を削除します。
例: namespace からタスク実行を削除する
$ tkn taskrun delete <task_run_name_1> <task_run_name_2> -n <namespace_name>
例: namespace から最近実行された 5 つのタスク以外のすべてのタスクを削除する
$ tkn taskrun delete -n <namespace_name> --keep 5 1
- 1
5を、保持する最近実行したタスク実行の数に置き換えます。
3.7.4. taskrun describe
タスク実行を記述します。
例: namespace で実行するタスクを記述する
$ tkn taskrun describe <task_run_name> -n <namespace_name>
3.7.5. taskrun list
タスク実行をリストします。
例: namespace のすべてのタスク実行をリストする
$ tkn taskrun list -n <namespace_name>
3.7.6. taskrun logs
タスク実行ログを表示します。
例: namespace で実行したタスクのライブログを表示する
$ tkn taskrun logs -f <task_run_name> -n <namespace_name>
3.8. Pipeline リソース管理コマンド
3.8.1. resource
Pipeline リソースを管理します。
例: ヘルプを表示する
$ tkn resource -h
3.8.2. resource create
Pipeline リソースを作成します。
例: namespace に Pipeline リソースを作成する
$ tkn resource create -n myspace
これは、リソースの名前、リソースのタイプ、およびリソースのタイプに基づく値の入力を要求するインタラクティブなコマンドです。
3.8.3. resource delete
Pipeline リソースを削除します。
例: namespace から myresource Pipeline リソースを削除する
$ tkn resource delete myresource -n myspace
3.8.4. resource describe
Pipeline リソースを記述します。
例: myresource Pipeline リソースを記述する
$ tkn resource describe myresource -n myspace
3.8.5. resource list
Pipeline リソースをリストします。
例: namespace のすべての Pipeline リソースをリストする
$ tkn resource list -n myspace
3.9. 管理コマンドのトリガー
3.9.1. eventlistener
EventListener を管理します。
例: ヘルプを表示する
$ tkn eventlistener -h
3.9.2. eventlistener delete
EventListener を削除します。
例: namespace の mylistener1 および mylistener2 EventListener を削除する
$ tkn eventlistener delete mylistener1 mylistener2 -n myspace
3.9.3. eventlistener describe
EventListener を記述します。
例: namespace の mylistener EventListener を記述する
$ tkn eventlistener describe mylistener -n myspace
3.9.4. eventlistener list
EventListener をリストします。
例: namespace のすべての EventListener をリストする
$ tkn eventlistener list -n myspace
3.9.5. eventlistener ログ
EventListener のログを表示します。
例: namespace に mylistener EventListener のログを表示する
$ tkn eventlistener logs mylistener -n myspace
3.9.6. triggerbinding
TriggerBinding を管理します。
例: TriggerBindings ヘルプを表示する
$ tkn triggerbinding -h
3.9.7. triggerbinding delete
TriggerBinding を削除します。
例: namespace の mybinding1 および mybinding2 TriggerBinding を削除する
$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace
3.9.8. triggerbinding describe
TriggerBinding を記述します。
例: namespace の mybinding TriggerBinding を記述する
$ tkn triggerbinding describe mybinding -n myspace
3.9.9. triggerbinding list
TriggerBinding をリストします。
例: namespace のすべての TriggerBinding をリストする
$ tkn triggerbinding list -n myspace
3.9.10. triggertemplate
TriggerTemplate を管理します。
例: TriggerTemplate ヘルプを表示する
$ tkn triggertemplate -h
3.9.11. triggertemplate delete
TriggerTemplate を削除します。
例: namespace の mytemplate1 および mytemplate2 TriggerTemplate を削除する
$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
3.9.12. triggertemplate describe
TriggerTemplate を記述します。
例: namespace の mytemplate TriggerTemplate を記述する
$ tkn triggertemplate describe mytemplate -n `myspace`
3.9.13. triggertemplate list
TriggerTemplate をリストします。
例: namespace のすべての TriggerTemplate をリストする
$ tkn triggertemplate list -n myspace
3.9.14. clustertriggerbinding
ClusterTriggerBinding を管理します。
例: ClusterTriggerBinding のヘルプを表示する
$ tkn clustertriggerbinding -h
3.9.15. clustertriggerbinding delete
ClusterTriggerBinding を削除します。
例: myclusterbinding1 および myclusterbinding2 ClusterTriggerBinding を削除する
$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
3.9.16. clustertriggerbinding describe
ClusterTriggerBinding を記述します。
例: myclusterbinding ClusterTriggerBinding を記述する
$ tkn clustertriggerbinding describe myclusterbinding
3.9.17. clustertriggerbinding list
ClusterTriggerBinding のリストを表示します。
例: すべての ClusterTriggerBinding をリストする
$ tkn clustertriggerbinding list
3.10. hub 対話コマンド
タスクやパイプラインなど、リソースの Tekton Hub と対話します。
3.10.1. hub
ハブと対話します。
例: ヘルプを表示する
$ tkn hub -h
例: ハブ API サーバーと対話する
$ tkn hub --api-server https://api.hub.tekton.dev
それぞれの例で、対応するサブコマンドとフラグを取得するには、tkn hub <command> --help を実行します。
3.10.2. hub downgrade
インストール済みのリソースをダウングレードします。
例: mynamespace namespace の mytask タスクを古いバージョンにダウングレードする
$ tkn hub downgrade task mytask --to version -n mynamespace
3.10.3. hub get
名前、種類、カタログ、およびバージョン別に、リソースマニフェストを取得します。
例: tekton カタログからの特定バージョンの myresource Pipeline またはタスクのマニフェストを取得する
$ tkn hub get [pipeline | task] myresource --from tekton --version version
3.10.4. hub info
名前、種類、カタログ、およびバージョン別に、リソースに関する情報を表示します。
例: tekton カタログからの特定バージョンの mytask タスクに関する情報を表示する
$ tkn hub info task mytask --from tekton --version version
3.10.5. hub install
種類、名前、バージョンごとにカタログからのリソースをインストールします。
例: mynamespace namespace の tekton カタログから mytask タスクの特定バージョンをインストールする
$ tkn hub install task mytask --from tekton --version version -n mynamespace
3.10.6. hub reinstall
種類および名前ごとにリソースを再インストールします。
例: mynamespace namespace の tekton カタログから mytask タスクの特定バージョンを再インストールする
$ tkn hub reinstall task mytask --from tekton --version version -n mynamespace
3.10.7. hub search
名前、種類、およびタグの組み合わせでリソースを検索します。
例: タグ cli でリソースを検索する
$ tkn hub search --tags cli
3.10.8. hub upgrade
インストール済みのリソースをアップグレードします。
例: mynamespace namespace のインストールされた mytask タスクを新しいバージョンにアップグレードする
$ tkn hub upgrade task mytask --to version -n mynamespace
