Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

Pipelines CLI (tkn) リファレンス

Red Hat OpenShift Pipelines 1.19

OpenShift Pipelines の tkn CLI リファレンス

Red Hat OpenShift Documentation Team

概要

このドキュメントでは、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 アーカイブとしてダウンロードできます。

手順

  1. 関連する CLI ツールをダウンロードします。

  1. アーカイブを展開します。 

    $ tar xvzf <file>
    Copy to Clipboard Toggle word wrap
  2. tkn、tkn-pac、および opc ファイルの場所を PATH 環境変数に追加します。

  3. PATH を確認するには、以下のコマンドを実行します。 

    $ echo $PATH
    Copy to Clipboard Toggle word wrap

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 権限がある。

手順

  1. Red Hat Subscription Manager に登録します。 

    # subscription-manager register
    Copy to Clipboard Toggle word wrap

  2. 最新のサブスクリプションデータをプルします。 

    # subscription-manager refresh
    Copy to Clipboard Toggle word wrap

  3. 利用可能なサブスクリプションをリストします。 

    # subscription-manager list --available --matches '*pipelines*'
    Copy to Clipboard Toggle word wrap

  4. 直前のコマンドの出力で、OpenShift Container Platform サブスクリプションのプール ID を見つけ、これを登録されたシステムにアタッチします。 

    # subscription-manager attach --pool=<pool_id>
    Copy to Clipboard Toggle word wrap

  5. Red Hat OpenShift Pipelines で必要なリポジトリーを有効にします。

    • Linux (x86_64, amd64) 

      # subscription-manager repos --enable="pipelines-1.19-for-rhel-8-x86_64-rpms"
      Copy to Clipboard Toggle word wrap

    • Linux on IBM zSystems および IBM® LinuxONE (s390x) 

      # subscription-manager repos --enable="pipelines-1.19-for-rhel-8-s390x-rpms"
      Copy to Clipboard Toggle word wrap

    • Linux on IBM Power (ppc64le) 

      # subscription-manager repos --enable="pipelines-1.19-for-rhel-8-ppc64le-rpms"
      Copy to Clipboard Toggle word wrap

    • ARM 上の Linux (aarch64、arm64) 

      # subscription-manager repos --enable="pipelines-1.19-for-rhel-8-aarch64-rpms"
      Copy to Clipboard Toggle word wrap

  6. openshift-pipelines-client パッケージをインストールします。 

    # yum install openshift-pipelines-client
    Copy to Clipboard Toggle word wrap

CLI のインストール後は、tkn コマンドを使用して利用できます。 

$ tkn version
Copy to Clipboard Toggle word wrap

1.3. Windows への Red Hat OpenShift Pipelines CLI のインストール
リンクのコピー

Windows の場合は、CLI を zip アーカイブとしてダウンロードできます。

手順

  1. CLI ツール をダウンロードします。
  2. ZIP プログラムでアーカイブを展開します。
  3. tkn、tkn-pac、および opc ファイルの場所を PATH 環境変数に追加します。

  4. PATH を確認するには、以下のコマンドを実行します。 

    C:\> path
    Copy to Clipboard Toggle word wrap

1.4. macOS への Red Hat OpenShift Pipelines CLI のインストール
リンクのコピー

macOS の場合は、CLI を tar.gz アーカイブとしてダウンロードできます。

手順

  1. 関連する CLI ツールをダウンロードします。

  2. アーカイブを解凍して解凍します。
  3. tkn、tkn-pac、および opc ファイルの場所を PATH 環境変数に追加します。

  4. PATH を確認するには、以下のコマンドを実行します。 

    $ echo $PATH
    Copy to Clipboard Toggle word wrap

第2章 OpenShift Pipelines tkn CLI の設定
リンクのコピー

タブ補完を有効にするように Red Hat OpenShift Pipelines tkn CLI を設定します。

2.1. タブ補完の有効化
リンクのコピー

tkn CLI ツールのインストール後、タブ補完を有効にして tkn コマンドの自動補完を実行するか、Tab キーを押す際にオプションの提案が表示されるようにすることができます。

前提条件

  • tkn CLI ツールがインストールされている。
  • ローカルシステムに bash-completion がインストールされている。

手順

以下の手順では、Bash のタブ補完を有効にします。

  1. Bash 補完コードをファイルに保存します。 

    $ tkn completion bash > tkn_bash_completion
    Copy to Clipboard Toggle word wrap

  2. ファイルを /etc/bash_completion.d/ にコピーします。 

    $ sudo cp tkn_bash_completion /etc/bash_completion.d/
    Copy to Clipboard Toggle word wrap

    または、ファイルをローカルディレクトリーに保存してから、これを .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
Copy to Clipboard Toggle word wrap

3.3.2. completion [shell]
リンクのコピー

インタラクティブな補完を提供するために評価する必要があるシェル補完コードを出力します。サポートされるシェルは bash および zsh です。

例: bash シェルの補完コード

$ tkn completion bash
Copy to Clipboard Toggle word wrap

3.3.3. version
リンクのコピー

tkn CLI のバージョン情報を出力します。

例: tkn バージョンを確認する

$ tkn version
Copy to Clipboard Toggle word wrap

3.4. Pipelines 管理コマンド
リンクのコピー

3.4.1. パイプライン
リンクのコピー

Pipeline を管理します。

例: ヘルプを表示する

$ tkn pipeline --help
Copy to Clipboard Toggle word wrap

3.4.2. pipeline delete
リンクのコピー

Pipeline を削除します。

例: namespace からパイプラインを削除する

$ tkn pipeline delete <pipeline_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.4.3. pipeline describe
リンクのコピー

Pipeline を記述します。

例: パイプラインを説明する

$ tkn pipeline describe <pipeline_name>
Copy to Clipboard Toggle word wrap

3.4.4. pipeline list
リンクのコピー

Pipeline のリストを表示します。

例: Pipeline のリストを表示する

$ tkn pipeline list
Copy to Clipboard Toggle word wrap

3.4.5. pipeline logs
リンクのコピー

特定の Pipeline のログを表示します。

例: Pipeline のライブログをストリーミングする

$ tkn pipeline logs -f <pipeline_name>
Copy to Clipboard Toggle word wrap

3.4.6. pipeline start
リンクのコピー

Pipeline を起動します。

例: Pipeline を起動する

$ tkn pipeline start <pipeline_name>
Copy to Clipboard Toggle word wrap

3.5. Pipeline 実行コマンド
リンクのコピー

3.5.1. pipelinerun
リンクのコピー

Pipeline 実行を管理します。

例: ヘルプを表示する

$ tkn pipelinerun -h
Copy to Clipboard Toggle word wrap

3.5.2. pipelinerun cancel
リンクのコピー

Pipeline 実行をキャンセルします。

例: namespace からの Pipeline 実行をキャンセルする

$ tkn pipelinerun cancel <pipeline_run_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.5.3. pipelinerun delete
リンクのコピー

Pipeline 実行を削除します。

例: namespace からの Pipeline 実行を削除する

$ tkn pipelinerun delete <pipeline_run_name_1> <pipeline_run_name_2> -n <namespace_name>
Copy to Clipboard Toggle word wrap

例: 最近実行された 5 つの Pipeline 実行を除き、namespace からすべての Pipeline 実行を削除する

$ tkn pipelinerun delete -n <namespace_name> --keep 5
1
Copy to Clipboard Toggle word wrap

1
5 を、保持する最近実行された Pipeline 実行の数に置き換えます。

例: すべての Pipeline を削除する

$ tkn pipelinerun delete --all
Copy to Clipboard Toggle word wrap

注記

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>
Copy to Clipboard Toggle word wrap

3.5.5. pipelinerun list
リンクのコピー

Pipeline 実行をリストします。

例: namespace での Pipeline 実行のリストを表示する

$ tkn pipelinerun list -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.5.6. pipelinerun logs
リンクのコピー

Pipeline 実行のログを表示します。

例: namespace 内のすべてのタスクとステップを含む Pipeline 実行のログを表示する

$ tkn pipelinerun logs <pipeline_run_name> -a -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.6. タスク管理コマンド
リンクのコピー

3.6.1. task
リンクのコピー

タスクを管理します。

例: ヘルプを表示する

$ tkn task -h
Copy to Clipboard Toggle word wrap

3.6.2. task delete
リンクのコピー

タスクを削除します。

例: namespace からタスクを削除する

$ tkn task delete <task_name_1> <task_name_2> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.6.3. task describe
リンクのコピー

タスクを記述します。

例: namespace 内のタスクを記述する

$ tkn task describe <task_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.6.4. task list
リンクのコピー

タスクをリストします。

例: namespace のすべてのタスクをリストする

$ tkn task list -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.6.5. task start
リンクのコピー

タスクを開始します。

例: namespace でタスクを開始する

$ tkn task start <task_name> -s <service_account_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.7. タスク実行コマンド
リンクのコピー

3.7.1. taskrun
リンクのコピー

タスク実行を管理します。

例: ヘルプを表示する

$ tkn taskrun -h
Copy to Clipboard Toggle word wrap

3.7.2. taskrun cancel
リンクのコピー

タスク実行をキャンセルします。

例: namespace から実行したタスクをキャンセルする

$ tkn taskrun cancel <task_run_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.7.3. taskrun delete
リンクのコピー

TaskRun を削除します。

例: namespace からタスク実行を削除する

$ tkn taskrun delete <task_run_name_1> <task_run_name_2> -n <namespace_name>
Copy to Clipboard Toggle word wrap

例: namespace から最近実行された 5 つのタスク以外のすべてのタスクを削除する

$ tkn taskrun delete -n <namespace_name> --keep 5
1
Copy to Clipboard Toggle word wrap

1
5 を、保持する最近実行したタスク実行の数に置き換えます。

3.7.4. taskrun describe
リンクのコピー

タスク実行を記述します。

例: namespace で実行するタスクを記述する

$ tkn taskrun describe <task_run_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.7.5. taskrun list
リンクのコピー

タスク実行をリストします。

例: namespace のすべてのタスク実行をリストする

$ tkn taskrun list -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.7.6. taskrun logs
リンクのコピー

タスク実行ログを表示します。

例: namespace で実行したタスクのライブログを表示する

$ tkn taskrun logs -f <task_run_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.8. Pipeline リソース管理コマンド
リンクのコピー

3.8.1. resource
リンクのコピー

Pipeline リソースを管理します。

例: ヘルプを表示する

$ tkn resource -h
Copy to Clipboard Toggle word wrap

3.8.2. resource create
リンクのコピー

Pipeline リソースを作成します。

例: namespace に Pipeline リソースを作成する

$ tkn resource create -n myspace
Copy to Clipboard Toggle word wrap

これは、リソースの名前、リソースのタイプ、およびリソースのタイプに基づく値の入力を要求するインタラクティブなコマンドです。

3.8.3. resource delete
リンクのコピー

Pipeline リソースを削除します。

例: namespace から myresource Pipeline リソースを削除する

$ tkn resource delete myresource -n myspace
Copy to Clipboard Toggle word wrap

3.8.4. resource describe
リンクのコピー

Pipeline リソースを記述します。

例: myresource Pipeline リソースを記述する

$ tkn resource describe myresource -n myspace
Copy to Clipboard Toggle word wrap

3.8.5. resource list
リンクのコピー

Pipeline リソースをリストします。

例: namespace のすべての Pipeline リソースをリストする

$ tkn resource list -n myspace
Copy to Clipboard Toggle word wrap

3.9. 管理コマンドのトリガー
リンクのコピー

3.9.1. eventlistener
リンクのコピー

EventListener を管理します。

例: ヘルプを表示する

$ tkn eventlistener -h
Copy to Clipboard Toggle word wrap

3.9.2. eventlistener delete
リンクのコピー

EventListener を削除します。

例: namespace の mylistener1 および mylistener2 EventListener を削除する

$ tkn eventlistener delete mylistener1 mylistener2 -n myspace
Copy to Clipboard Toggle word wrap

3.9.3. eventlistener describe
リンクのコピー

EventListener を記述します。

例: namespace の mylistener EventListener を記述する

$ tkn eventlistener describe mylistener -n myspace
Copy to Clipboard Toggle word wrap

3.9.4. eventlistener list
リンクのコピー

EventListener をリストします。

例: namespace のすべての EventListener をリストする

$ tkn eventlistener list -n myspace
Copy to Clipboard Toggle word wrap

3.9.5. eventlistener ログ
リンクのコピー

EventListener のログを表示します。

例: namespace に mylistener EventListener のログを表示する

$ tkn eventlistener logs mylistener -n myspace
Copy to Clipboard Toggle word wrap

3.9.6. triggerbinding
リンクのコピー

TriggerBinding を管理します。

例: TriggerBindings ヘルプを表示する

$ tkn triggerbinding -h
Copy to Clipboard Toggle word wrap

3.9.7. triggerbinding delete
リンクのコピー

TriggerBinding を削除します。

例: namespace の mybinding1 および mybinding2 TriggerBinding を削除する

$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace
Copy to Clipboard Toggle word wrap

3.9.8. triggerbinding describe
リンクのコピー

TriggerBinding を記述します。

例: namespace の mybinding TriggerBinding を記述する

$ tkn triggerbinding describe mybinding -n myspace
Copy to Clipboard Toggle word wrap

3.9.9. triggerbinding list
リンクのコピー

TriggerBinding をリストします。

例: namespace のすべての TriggerBinding をリストする

$ tkn triggerbinding list -n myspace
Copy to Clipboard Toggle word wrap

3.9.10. triggertemplate
リンクのコピー

TriggerTemplate を管理します。

例: TriggerTemplate ヘルプを表示する

$ tkn triggertemplate -h
Copy to Clipboard Toggle word wrap

3.9.11. triggertemplate delete
リンクのコピー

TriggerTemplate を削除します。

例: namespace の mytemplate1 および mytemplate2 TriggerTemplate を削除する

$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
Copy to Clipboard Toggle word wrap

3.9.12. triggertemplate describe
リンクのコピー

TriggerTemplate を記述します。

例: namespace の mytemplate TriggerTemplate を記述する

$ tkn triggertemplate describe mytemplate -n `myspace`
Copy to Clipboard Toggle word wrap

3.9.13. triggertemplate list
リンクのコピー

TriggerTemplate をリストします。

例: namespace のすべての TriggerTemplate をリストする

$ tkn triggertemplate list -n myspace
Copy to Clipboard Toggle word wrap

3.9.14. clustertriggerbinding
リンクのコピー

ClusterTriggerBinding を管理します。

例: ClusterTriggerBinding のヘルプを表示する

$ tkn clustertriggerbinding -h
Copy to Clipboard Toggle word wrap

3.9.15. clustertriggerbinding delete
リンクのコピー

ClusterTriggerBinding を削除します。

例: myclusterbinding1 および myclusterbinding2 ClusterTriggerBinding を削除する

$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
Copy to Clipboard Toggle word wrap

3.9.16. clustertriggerbinding describe
リンクのコピー

ClusterTriggerBinding を記述します。

例: myclusterbinding ClusterTriggerBinding を記述する

$ tkn clustertriggerbinding describe myclusterbinding
Copy to Clipboard Toggle word wrap

3.9.17. clustertriggerbinding list
リンクのコピー

ClusterTriggerBinding のリストを表示します。

例: すべての ClusterTriggerBinding をリストする

$ tkn clustertriggerbinding list
Copy to Clipboard Toggle word wrap

3.10. hub 対話コマンド
リンクのコピー

タスクやパイプラインなど、リソースの Tekton Hub と対話します。

3.10.1. hub
リンクのコピー

ハブと対話します。

例: ヘルプを表示する

$ tkn hub -h
Copy to Clipboard Toggle word wrap

例: ハブ API サーバーと対話する

$ tkn hub --api-server https://api.hub.tekton.dev
Copy to Clipboard Toggle word wrap

注記

それぞれの例で、対応するサブコマンドとフラグを取得するには、tkn hub <command> --help を実行します。

3.10.2. hub downgrade
リンクのコピー

インストール済みのリソースをダウングレードします。

例: mynamespace namespace の mytask タスクを古いバージョンにダウングレードする

$ tkn hub downgrade task mytask --to version -n mynamespace
Copy to Clipboard Toggle word wrap

3.10.3. hub get
リンクのコピー

名前、種類、カタログ、およびバージョン別に、リソースマニフェストを取得します。

例: tekton カタログからの特定バージョンの myresource Pipeline またはタスクのマニフェストを取得する

$ tkn hub get [pipeline | task] myresource --from tekton --version version
Copy to Clipboard Toggle word wrap

3.10.4. hub info
リンクのコピー

名前、種類、カタログ、およびバージョン別に、リソースに関する情報を表示します。

例: tekton カタログからの特定バージョンの mytask タスクに関する情報を表示する

$ tkn hub info task mytask --from tekton --version version
Copy to Clipboard Toggle word wrap

3.10.5. hub install
リンクのコピー

種類、名前、バージョンごとにカタログからのリソースをインストールします。

例: mynamespace namespace の tekton カタログから mytask タスクの特定バージョンをインストールする

$ tkn hub install task mytask --from tekton --version version -n mynamespace
Copy to Clipboard Toggle word wrap

3.10.6. hub reinstall
リンクのコピー

種類および名前ごとにリソースを再インストールします。

例: mynamespace namespace の tekton カタログから mytask タスクの特定バージョンを再インストールする

$ tkn hub reinstall task mytask --from tekton --version version -n mynamespace
Copy to Clipboard Toggle word wrap

3.10.8. hub upgrade
リンクのコピー

インストール済みのリソースをアップグレードします。

例: mynamespace namespace のインストールされた mytask タスクを新しいバージョンにアップグレードする

$ tkn hub upgrade task mytask --to version -n mynamespace
Copy to Clipboard Toggle word wrap

法律上の通知
リンクのコピー

Copyright © 2025 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat