Pipelines CLI (tkn)リファレンス


Red Hat OpenShift Pipelines 1.15

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. アーカイブを展開します。

    $ tar xvzf <file>
  2. tkntkn-pac、および opc ファイルの場所を PATH 環境変数に追加します。
  3. 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 権限がある。

手順

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

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

    # subscription-manager refresh
  3. 利用可能なサブスクリプションをリスト表示します。

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

    # subscription-manager attach --pool=<pool_id>
  5. Red Hat OpenShift Pipelines で必要なリポジトリーを有効にします。

    • Linux (x86_64, amd64)

      # subscription-manager repos --enable="pipelines-1.15-for-rhel-8-x86_64-rpms"
    • Linux on IBM zSystems および IBM® LinuxONE (s390x)

      # subscription-manager repos --enable="pipelines-1.15-for-rhel-8-s390x-rpms"
    • Linux on IBM Power (ppc64le)

      # subscription-manager repos --enable="pipelines-1.15-for-rhel-8-ppc64le-rpms"
    • ARM 上の Linux (aarch64、arm64)

      # subscription-manager repos --enable="pipelines-1.15-for-rhel-8-aarch64-rpms"
  6. openshift-pipelines-client パッケージをインストールします。

    # yum install openshift-pipelines-client

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

$ tkn version

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

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

手順

  1. CLI ツール をダウンロードします。
  2. ZIP プログラムでアーカイブを展開します。
  3. tkntkn-pac、および opc ファイルの場所を PATH 環境変数に追加します。
  4. PATH を確認するには、以下のコマンドを実行します。

    C:\> path

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

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

手順

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

  2. アーカイブを解凍して解凍します。
  3. tkntkn-pac、および opc ファイルの場所を PATH 環境変数に追加します。
  4. PATH を確認するには、以下のコマンドを実行します。

    $ echo $PATH

第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
  2. ファイルを /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 のログを表示します。

例:パイプラインのライブログのストリーミング

$ tkn pipeline logs -f <pipeline_name>

3.4.6. pipeline start

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 でのパイプラインの実行を記述します。

$ 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 のすべてのタスクおよび手順を含むパイプライン実行のログ表示

$ 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. ClusterTask 管理コマンド

重要

Red Hat OpenShift Pipelines 1.10 では、tkn コマンドラインユーティリティーの ClusterTask 機能が非推奨になり、将来のリリースで削除される予定です。

3.9.1. clustertask

ClusterTask を管理します。

例: ヘルプの表示

$ tkn clustertask --help

3.9.2. clustertask delete

クラスターの ClusterTask リソースを削除します。

例: mytask1 および mytask2 ClusterTask の削除

$ tkn clustertask delete mytask1 mytask2

3.9.3. clustertask describe

ClusterTask を記述します。

例: mytask ClusterTask の記述

$ tkn clustertask describe mytask1

3.9.4. clustertask list

ClusterTask をリスト表示します。

例: ClusterTask のリスト表示

$ tkn clustertask list

3.9.5. clustertask start

ClusterTask を開始します。

例: mytask ClusterTask の開始

$ tkn clustertask start mytask

3.10. 管理コマンドのトリガー

3.10.1. eventlistener

EventListener を管理します。

例: ヘルプの表示

$ tkn eventlistener -h

3.10.2. eventlistener delete

EventListener を削除します。

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

$ tkn eventlistener delete mylistener1 mylistener2 -n myspace

3.10.3. eventlistener describe

EventListener を記述します。

例: namespace の mylistener EventListener の記述

$ tkn eventlistener describe mylistener -n myspace

3.10.4. eventlistener list

EventListener をリスト表示します。

例: namespace のすべての EventListener の一覧表示

$ tkn eventlistener list -n myspace

3.10.5. eventlistener ログ

EventListener のログを表示します。

例: namespace の mylistener EventListener のログ表示

$ tkn eventlistener logs mylistener -n myspace

3.10.6. triggerbinding

TriggerBinding を管理します。

例: TriggerBindings ヘルプの表示

$ tkn triggerbinding -h

3.10.7. triggerbinding delete

TriggerBinding を削除します。

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

$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace

3.10.8. triggerbinding describe

TriggerBinding を記述します。

例: namespace の mybinding TriggerBinding の記述

$ tkn triggerbinding describe mybinding -n myspace

3.10.9. triggerbinding list

TriggerBinding をリスト表示します。

例: namespace のすべての TriggerBinding のリスト表示

$ tkn triggerbinding list -n myspace

3.10.10. triggertemplate

TriggerTemplate を管理します。

例: TriggerTemplate ヘルプの表示

$ tkn triggertemplate -h

3.10.11. triggertemplate delete

TriggerTemplate を削除します。

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

$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`

3.10.12. triggertemplate describe

TriggerTemplate を記述します。

例: namespace の mytemplate TriggerTemplate の記述

$ tkn triggertemplate describe mytemplate -n `myspace`

3.10.13. triggertemplate list

TriggerTemplate をリスト表示します。

例: namespace のすべての TriggerTemplate のリスト表示

$ tkn triggertemplate list -n myspace

3.10.14. clustertriggerbinding

ClusterTriggerBinding を管理します。

例: ClusterTriggerBinding のヘルプの表示

$ tkn clustertriggerbinding -h

3.10.15. clustertriggerbinding delete

ClusterTriggerBinding を削除します。

例: myclusterbinding1 および myclusterbinding2 ClusterTriggerBinding の削除

$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2

3.10.16. clustertriggerbinding describe

ClusterTriggerBinding を記述します。

例: myclusterbinding ClusterTriggerBinding の記述

$ tkn clustertriggerbinding describe myclusterbinding

3.10.17. clustertriggerbinding list

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

例: すべての ClusterTriggerBinding の一覧表示

$ tkn clustertriggerbinding list

3.11. hub 対話コマンド

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

3.11.1. hub

ハブと対話します。

例: ヘルプの表示

$ tkn hub -h

例: ハブ API サーバーとの対話

$ tkn hub --api-server https://api.hub.tekton.dev

注記

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

3.11.2. hub downgrade

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

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

$ tkn hub downgrade task mytask --to version -n mynamespace

3.11.3. hub get

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

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

$ tkn hub get [pipeline | task] myresource --from tekton --version version

3.11.4. hub info

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

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

$ tkn hub info task mytask --from tekton --version version

3.11.5. hub install

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

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

$ tkn hub install task mytask --from tekton --version version -n mynamespace

3.11.6. hub reinstall

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

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

$ tkn hub reinstall task mytask --from tekton --version version -n mynamespace

3.11.8. hub upgrade

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

例: mynamespace namespace のインストールされた mytask タスクの新規バージョンへのアップグレード

$ tkn hub upgrade task mytask --to version -n mynamespace

法律上の通知

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

© 2024 Red Hat, Inc.