3.5. OpenShift Pipelines namespace で提供されるタスク

PDF

OpenShift Pipelines のインストールには、パイプラインで使用できる一連の標準タスクが含まれています。これらのタスクは、OpenShift Pipelines インストール namespace (通常は openshift-pipelines namespace) にあります。クラスターリゾルバーを使用してタスクにアクセスできます。

ClusterTask 機能は OpenShift Pipelines 1.10 以降では非推奨となり、今後のリリースで削除される予定です。パイプラインで ClusterTasks を使用する場合は、クラスターリゾルバーを使用して、OpenShift Pipelines インストール namespace から利用可能なタスクでパイプラインを再作成できます。ただし、既存の ClusterTasks と比較して、これらのタスクには特定の変更が加えられています。

OpenShift Pipelines インストール namespace で利用可能なタスクのいずれかでカスタム実行イメージを指定することはできません。これらのタスクは、BUILDER_IMAGE、gitInitImage、KN_IMAGE などのパラメーターをサポートしません。カスタム実行イメージを使用する場合は、タスクのコピーを作成し、そのコピーを編集してイメージを置き換えます。

buildah

buildah タスクは、ソースコードツリーをコンテナーイメージにビルドし、そのイメージをコンテナーレジストリーにプッシュします。

buildah タスクの使用例

apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: build-and-deploy
spec:
# ...
  tasks:
# ...
  - name: build-image
    taskRef:
      resolver: cluster
      params:
      - name: kind
        value: task
      - name: name
        value: buildah
      - name: namespace
        value: openshift-pipelines
    params:
    - name: IMAGE
      value: $(params.IMAGE)
    workspaces:
    - name: source
      workspace: shared-workspace
# ...

表3.5 buildah タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`IMAGE`	Buildah によってビルドされる完全修飾コンテナーイメージ名。	`string`
`DOCKERFILE`	`source` ワークスペースを基準とした `Dockerfile` (または `Containerfile`) へのパス。	`string`	`./Dockerfile`
`CONTEXT`	コンテキストとして使用するディレクトリーへのパス。	`string`	`.`
`STORAGE_DRIVER`	Buildah ストレージドライバーを設定して、現在のクラスターノード設定を反映します。	`string`	`vfs`
`FORMAT`	ビルドするコンテナーの形式。`oci` または `docker` のいずれかです。	`string`	`oci`
`BUILD_EXTRA_ARGS`	イメージをビルドするときの `build` コマンドの追加パラメーター。	`string`
`PUSH_EXTRA_ARGS`	イメージをプッシュするときの `push` コマンドの追加パラメーター。	`string`
`SKIP_PUSH`	コンテナーレジストリーへのイメージのプッシュをスキップします。	`string`	`false`
`TLS_VERIFY`	TLS 検証フラグ。通常は `true` です。	`string`	`true`
`VERBOSE`	詳細なロギングをオンにすると、実行されたすべてのコマンドがログに追加されます。	`string`	`false`

表3.6 buildah タスクでサポートされているワークスペース
ワークスペース	説明
`source`	コンテナービルドコンテキスト。通常、`Dockerfile` または `Containerfile` ファイルが含まれるアプリケーションのソースコードです。
`dockerconfig`	Buildah がコンテナーレジストリーへのアクセスに使用する `.docker/config.json` ファイルを提供するためのオプションワークスペース。ファイルを `config.json` または `.dockerconfigjson` という名前のワークスペースの root に配置します。
`rhel-entitlement`	Buildah が Red Hat Enterprise Linux (RHEL) サブスクリプションへのアクセスに使用するエンタイトルメントキーを提供するためのオプションのワークスペース。マウントされたワークスペースには、`entitlement.pem` ファイルと `entitlement-key.pem` ファイルが含まれている必要があります。

表3.7 buildah タスクが返す結果
結果	タイプ	説明
`IMAGE_URL`	`string`	ビルドされたイメージの完全修飾名。
`IMAGE_DIGEST`	`string`	ビルドされたイメージのダイジェスト。

buildah ClusterTaskからの変更点

VERBOSE パラメーターが追加されました。
BUILDER_IMAGE パラメーターが削除されました。

git-cli

git-cli タスクは、git コマンドラインユーティリティーを実行します。GIT_SCRIPT パラメーターを使用して、完全な Git コマンドまたは複数のコマンドを渡すことができます。たとえば、プッシュを完了するためにコマンドが Git リポジトリーへの認証を必要とする場合は、認証のクレデンシャルを指定する必要があります。

git-cli タスクの使用例

apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: update-repo
spec:
# ...
  tasks:
# ...
  - name: push-to-repo
    taskRef:
      resolver: cluster
      params:
      - name: kind
        value: task
      - name: name
        value: git-cli
      - name: namespace
        value: openshift-pipelines
    params:
    - name: GIT_SCRIPT
      value: "git push"
    - name: GIT_USER_NAME
      value: "Example Developer"
    - name: GIT_USER_EMAIL
      value: "developer@example.com"
    workspaces:
    - name: ssh-directory
      workspace: ssh-workspace 1
    - name: source
      workspace: shared-workspace
# ...

1: この例では、ssh-workspace には、Git リポジトリーへの認可に有効なキーを含む .ssh ディレクトリーの内容が含まれている必要があります。

表3.8 git-cli タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`CRT_FILENAME`	`ssl-ca-directory` ワークスペース内の認証局 (CA) のバンドルファイル名。	`string`	`ca-bundle.crt`
`HTTP_PROXY`	HTTP プロキシーサーバー (TLS 以外のリクエスト)。	`string`
`HTTPS_PROXY`	HTTPS プロキシーサーバー (TLS リクエスト)。	`string`
`NO_PROXY`	HTTP/HTTPS リクエストのプロキシーをオプトアウトします。	`string`
`SUBDIRECTORY`	Git リポジトリーが存在する `source` ワークスペースへの相対パス。	`string`
`USER_HOME`	Pod 内の Git ユーザーのホームディレクトリーへの絶対パス。	`string`	`/home/git`
`DELETE_EXISTING`	Git 操作を完了する前に、`source` ワークスペースの既存のコンテンツをすべて消去します。	`string`	`true`
`VERBOSE`	実行したすべてのコマンドをログに記録します。	`string`	`false`
`SSL_VERIFY`	グローバル `http.sslVerify` 値。リモートリポジトリーを信頼していない限り、`false` を使用しないでください。	`string`	`true`
`GIT_USER_NAME`	Git 操作を実行するための Git ユーザー名。	`string`
`GIT_USER_EMAIL`	Git 操作を実行するための Git ユーザーのメール。	`string`
`GIT_SCRIPT`	実行する Git スクリプト。	`string`	`git help`

表3.9 git-cli タスクでサポートされているワークスペース
ワークスペース	説明
`ssh-directory`	必要に応じて、秘密鍵、`known_hosts`、`config` などのファイルを含む `.ssh` ディレクトリー。このワークスペースを指定すると、タスクは Git リポジトリーへの認証にこのワークスペースを使用します。認証情報を安全に保存するために、このワークスペースを `Secret` リソースにバインドします。
`basic-auth`	`.gitconfig` および `.git-credentials` ファイルが含まれるワークスペース。このワークスペースを指定すると、タスクは Git リポジトリーへの認証にこのワークスペースを使用します。可能な場合は、認証に `basic-auth` ではなく `ssh-directory` ワークスペースを使用します。認証情報を安全に保存するために、このワークスペースを `Secret` リソースにバインドします。
`ssl-ca-directory`	CA 証明書を含むワークスペース。このワークスペースを指定すると、Git は HTTPS を使用してリモートリポジトリーとやり取りする場合に、これらの証明書を使用してピアを検証します。
`source`	取得した Git リポジトリーを含むワークスペース。
`input`	Git リポジトリーに追加する必要があるファイルが含まれるオプションのワークスペース。`$(workspaces.input.path)` を使用して、スクリプトからワークスペースにアクセスできます。以下に例を示します。 `cp $(workspaces.input.path)/<file_that_i_want> .` `git add <file_that_i_want>`

表3.10 git-cli タスクが返す結果
結果	タイプ	説明
`COMMIT`	`string`	クローンされた Git リポジトリー内の現在のブランチの HEAD にあるコミットの SHA ダイジェスト。

git-cli ClusterTask からの変更点

新しいパラメーターが複数追加されました。
BASE_IMAGE パラメーターが削除されました。
ssl-ca-directory ワークスペースが追加されました。
USER_HOME および VERBOSE パラメーターのデフォルト値が変更されました。
結果の名前が commit から COMMIT に変更されました。

git-clone

git-clone タスクは、Git を使用してワークスペース上のリモートリポジトリーを初期化し、クローンを作成します。このタスクは、このソースコードをビルドまたは処理するパイプラインの開始時に使用できます。

git-clone タスクの使用例

apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: build-source
spec:
# ...
  tasks:
  - name: clone-repo
    taskRef:
      resolver: cluster
      params:
      - name: kind
        value: task
      - name: name
        value: git-clone
      - name: namespace
        value: openshift-pipelines
    params:
    - name: URL
      value: "https://github.com/example/repo.git"
    workspaces:
    - name: output
      workspace: shared-workspace

表3.11 git-clone タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`CRT_FILENAME`	`ssl-ca-directory` ワークスペース内の認証局 (CA) のバンドルファイル名。	`string`	`ca-bundle.crt`
`HTTP_PROXY`	HTTP プロキシーサーバー (TLS 以外のリクエスト)。	`string`
`HTTPS_PROXY`	HTTPS プロキシーサーバー (TLS リクエスト)。	`string`
`NO_PROXY`	HTTP/HTTPS リクエストのプロキシーをオプトアウトします。	`string`
`SUBDIRECTORY`	タスクが Git リポジトリーを配置する `output` ワークスペース内の相対パス。	`string`
`USER_HOME`	Pod 内の Git ユーザーのホームディレクトリーへの絶対パス。	`string`	`/home/git`
`DELETE_EXISTING`	Git 操作を実行する前に、デフォルトのワークスペースにコンテンツが存在する場合は削除します。	`string`	`true`
`VERBOSE`	実行したコマンドをログに記録します。	`string`	`false`
`SSL_VERIFY`	グローバル `http.sslVerify` 値。リモートリポジトリーを信頼していない限り、このパラメーターを `false` に設定しないでください。	`string`	`true`
`URL`	Git リポジトリー URL	`string`
`リビジョン`	チェックアウトするリビジョン (ブランチやタグなど)。	`string`	`main`
`REFSPEC`	リビジョンをチェックアウトする前にタスクが取得するリポジトリーの `refspec` 文字列。	`string`
`SUBMODULES`	Git サブモジュールを初期化して取得します。	`string`	`true`
`DEPTH`	取得するコミットの数。"シャロークローン" は単一のコミットです。	`string`	`1`
`SPARSE_CHECKOUT_DIRECTORIES`	"スパースチェックアウト" を実行するための、コンマで区切られたディレクトリーパターンのリスト。	`string`

表3.12 git-clone タスクでサポートされているワークスペース
ワークスペース	説明
`ssh-directory`	必要に応じて、秘密鍵、`known_hosts`、`config` などのファイルを含む `.ssh` ディレクトリー。このワークスペースを指定すると、タスクは Git リポジトリーへの認証にこのワークスペースを使用します。認証情報を安全に保存するために、このワークスペースを `Secret` リソースにバインドします。
`basic-auth`	`.gitconfig` および `.git-credentials` ファイルが含まれるワークスペース。このワークスペースを指定すると、タスクは Git リポジトリーへの認証にこのワークスペースを使用します。可能な場合は、認証に `basic-auth` ではなく `ssh-directory` ワークスペースを使用します。認証情報を安全に保存するために、このワークスペースを `Secret` リソースにバインドします。
`ssl-ca-directory`	CA 証明書を含むワークスペース。このワークスペースを指定すると、Git は HTTPS を使用してリモートリポジトリーとやり取りする場合に、これらの証明書を使用してピアを検証します。
`出力 (output)`	取得した Git リポジトリーを含むワークスペース。データはワークスペースのルートまたは `SUBDIRECTORY` パラメーターで定義された相対パスに配置されます。

表3.13 git-clone タスクが返す結果
結果	タイプ	説明
`COMMIT`	`string`	クローンされた Git リポジトリー内の現在のブランチの HEAD にあるコミットの SHA ダイジェスト。
`URL`	`string`	クローンされたリポジトリーの URL。
`COMMITTER_DATE`	`string`	クローンされた Git リポジトリー内の現在のブランチの HEAD にあるコミットのエポックタイムスタンプ。

git-clone ClusterTask からの変更点

すべてのパラメーター名が大文字に変更されました。
すべての結果名が大文字に変更されました。
gitInitImage パラメーターが削除されました。

kn

kn タスクは、kn コマンドラインユーティリティーを使用して、サービス、リビジョン、ルートなどの Knative リソースでの操作を完了します。

kn タスクの使用例

apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
 name: kn-run
spec:
 pipelineSpec:
   tasks:
   - name: kn-run
     taskRef:
       resolver: cluster
       params:
       - name: kind
         value: task
       - name: name
         value: kn
       - name: namespace
         value: openshift-pipelines
     params:
     - name: ARGS
       value: [version]

表3.14 kn タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`ARGS`	`kn` ユーティリティーの引数。	`array`	`- help`

kn ClusterTask からの変更点

KN_IMAGE パラメーターが削除されました。

kn-apply

kn-apply タスクは、指定されたイメージを Knative サービスにデプロイします。このタスクは、kn service apply コマンドを使用して、指定された Knative サービスを作成または更新します。

kn-apply タスクの使用例

apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
 name: kn-apply-run
spec:
 pipelineSpec:
   tasks:
   - name: kn-apply-run
     taskRef:
       resolver: cluster
       params:
       - name: kind
         value: task
       - name: name
         value: kn-apply
       - name: namespace
         value: openshift-pipelines
     params:
     - name: SERVICE
       value: "hello"
     - name: IMAGE
       value: "gcr.io/knative-samples/helloworld-go:latest"

表3.15 kn-apply タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`サービス`	Knative サービス名。	`string`
`IMAGE`	デプロイするイメージの完全修飾名。	`string`

kn-apply ClusterTask からの変更点

KN_IMAGE パラメーターが削除されました。

maven

Maven タスクは Maven ビルドを実行します。

Maven タスクの使用例

apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: build-and-deploy
spec:
# ...
  tasks:
# ...
  - name: build-from-source
    taskRef:
      resolver: cluster
      params:
      - name: kind
        value: task
      - name: name
        value: maven
      - name: namespace
        value: openshift-pipelines
    workspaces:
    - name: source
      workspace: shared-workspace
# ...

表3.16 Maven タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`GOALS`	実行する Maven の目標。	`array`	`- package`
`MAVEN_MIRROR_URL`	Maven リポジトリーのミラー URL。	`string`
`SUBDIRECTORY`	タスクが Maven ビルドを実行する `source` ワークスペース内のサブディレクトリー。	`string`	`.`

表3.17 Maven タスクでサポートされているワークスペース
ワークスペース	説明
`source`	Maven プロジェクトが含まれるワークスペース。
`server_secret`	ユーザー名やパスワードなど、Maven サーバーに接続するためのシークレットが含まれるワークスペース。
`proxy_secret`	ユーザー名やパスワードなど、プロキシーサーバーに接続するための認証情報が含まれるワークスペース。
`proxy_configmap`	`proxy_port`、`proxy_host`、`proxy_protocol`、`proxy_non_proxy_hosts` などのプロキシー設定値が含まれるワークスペース。
`maven_settings`	カスタム Maven 設定が含まれるワークスペース。

Maven ClusterTask からの変更

CONTEXT_DIR のパラメーター名が SUBDIRECTORY に変更されました。
maven-settings のワークスペース名が maven_settings に変更されました。

openshift-client

openshift-client タスクは、oc コマンドラインインターフェイスを使用してコマンドを実行します。このタスクを使用して、OpenShift Container Platform クラスターを管理できます。

openshift-client タスクの使用例

apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
 name: openshift-client-run
spec:
 pipelineSpec:
   tasks:
   - name: openshift-client-run
     taskRef:
       resolver: cluster
       params:
       - name: kind
         value: task
       - name: name
         value: openshift-client
       - name: namespace
         value: openshift-pipelines
     params:
     - name: SCRIPT
       value: "oc version"

表3.18 openshift-client タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`SCRIPT`	実行する `oc` CLI 引数。	`string`	`oc help`
`VERSION`	使用する OpenShift Container Platform バージョン。	`string`	`latest`

表3.19 openshift-client タスクでサポートされているワークスペース
ワークスペース	説明
`manifest_dir`	`oc` ユーティリティーを使用して適用するマニフェストファイルが含まれるワークスペース。
`kubeconfig_dir`	クラスターにアクセスするための認証情報を含む `.kube/config` ファイルを提供できるオプションのワークスペース。このファイルをワークスペースのルートに配置し、`kubeconfig` という名前を付けます。

openshift-client ClusterTask からの変更点

ワークスペース名 manifest-dir が manifest_dir に変更されました。
ワークスペース名 kubeconfig-dir が kubeconfig_dir に変更されました。

s2i-dotnet

s2i-dotnet タスクは、OpenShift Container Platform レジストリーから image-registry.openshift-image-registry.svc:5000/openshift/dotnet として入手できる Source to Image (S2I) dotnet ビルダーイメージを使用してソースコードをビルドします。

s2i-dotnet タスクの使用例

apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: build-and-deploy
spec:
# ...
  tasks:
# ...
  - name: build-s2i
    taskRef:
      resolver: cluster
      params:
      - name: kind
        value: task
      - name: name
        value: s2i-dotnet
      - name: namespace
        value: openshift-pipelines
    workspaces:
    - name: source
      workspace: shared-workspace
# ...

表3.20 s2i-dotnet タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`IMAGE`	S2I プロセスがビルドするコンテナーイメージの完全修飾名。	`string`
`IMAGE_SCRIPTS_URL`	ビルダーイメージのデフォルトのアセンブルおよび実行スクリプトを含む URL。	`string`	`image:///usr/libexec/s2i`
`ENV_VARS`	ビルドプロセスで設定する環境変数の値の配列。`KEY=VALUE` 形式でリストされます。	`array`
`CONTEXT`	コンテキストとして使用する `source` ワークスペース内のディレクトリーへのパス。	`string`	`.`
`STORAGE_DRIVER`	Buildah ストレージドライバーを設定して、現在のクラスターノード設定を反映します。	`string`	`vfs`
`FORMAT`	ビルドするコンテナーの形式。`oci` または `docker` のいずれかです。	`string`	`oci`
`BUILD_EXTRA_ARGS`	イメージをビルドするときの `build` コマンドの追加パラメーター。	`string`
`PUSH_EXTRA_ARGS`	イメージをプッシュするときの `push` コマンドの追加パラメーター。	`string`
`SKIP_PUSH`	コンテナーレジストリーへのイメージのプッシュをスキップします。	`string`	`false`
`TLS_VERIFY`	TLS 検証フラグ。通常は `true` です。	`string`	`true`
`VERBOSE`	詳細なロギングをオンにすると、実行されたすべてのコマンドがログに追加されます。	`string`	`false`
`VERSION`	言語バージョンに対応するイメージストリームのタグ。	`string`	`latest`

表3.21 s2i-dotnet タスクでサポートされているワークスペース
ワークスペース	説明
`source`	S2I ワークフローのビルドコンテキストであるアプリケーションソースコード。
`dockerconfig`	Buildah がコンテナーレジストリーへのアクセスに使用する `.docker/config.json` ファイルを提供するためのオプションワークスペース。ファイルを `config.json` または `.dockerconfigjson` という名前のワークスペースの root に配置します。

表3.22 s2i-dotnet タスクが返す結果
結果	タイプ	説明
`IMAGE_URL`	`string`	ビルドされたイメージの完全修飾名。
`IMAGE_DIGEST`	`string`	ビルドされたイメージのダイジェスト。

s2i-dotnet ClusterTask からの変更点

新しいパラメーターが複数追加されました。
BASE_IMAGE パラメーターが削除されました。
パラメーター名 PATH_CONTEXT が CONTEXT に変更されました。
パラメーター名 TLS_VERIFY が TLSVERIFY に変更されました。
IMAGE_URL の結果が追加されました。

s2i-go

s2i-go タスクは、OpenShift Container Platform レジストリーから image-registry.openshift-image-registry.svc:5000/openshift/golang として入手できる S2I Golang ビルダーイメージを使用してソースコードをビルドします。

s2i-go タスクの使用例

apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: build-and-deploy
spec:
# ...
  tasks:
# ...
  - name: build-s2i
    taskRef:
      resolver: cluster
      params:
      - name: kind
        value: task
      - name: name
        value: s2i-go
      - name: namespace
        value: openshift-pipelines
    workspaces:
    - name: source
      workspace: shared-workspace
# ...

表3.23 s2i-go タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`IMAGE`	S2I プロセスがビルドするコンテナーイメージの完全修飾名。	`string`
`IMAGE_SCRIPTS_URL`	ビルダーイメージのデフォルトのアセンブルおよび実行スクリプトを含む URL。	`string`	`image:///usr/libexec/s2i`
`ENV_VARS`	ビルドプロセスで設定する環境変数の値の配列。`KEY=VALUE` 形式でリストされます。	`array`
`CONTEXT`	コンテキストとして使用する `source` ワークスペース内のディレクトリーへのパス。	`string`	`.`
`STORAGE_DRIVER`	Buildah ストレージドライバーを設定して、現在のクラスターノード設定を反映します。	`string`	`vfs`
`FORMAT`	ビルドするコンテナーの形式。`oci` または `docker` のいずれかです。	`string`	`oci`
`BUILD_EXTRA_ARGS`	イメージをビルドするときの `build` コマンドの追加パラメーター。	`string`
`PUSH_EXTRA_ARGS`	イメージをプッシュするときの `push` コマンドの追加パラメーター。	`string`
`SKIP_PUSH`	コンテナーレジストリーへのイメージのプッシュをスキップします。	`string`	`false`
`TLS_VERIFY`	TLS 検証フラグ。通常は `true` です。	`string`	`true`
`VERBOSE`	詳細なロギングをオンにすると、実行されたすべてのコマンドがログに追加されます。	`string`	`false`
`VERSION`	言語バージョンに対応するイメージストリームのタグ。	`string`	`latest`

表3.24 s2i-go タスクでサポートされているワークスペース
ワークスペース	説明
`source`	S2I ワークフローのビルドコンテキストであるアプリケーションソースコード。
`dockerconfig`	Buildah がコンテナーレジストリーへのアクセスに使用する `.docker/config.json` ファイルを提供するためのオプションワークスペース。ファイルを `config.json` または `.dockerconfigjson` という名前のワークスペースの root に配置します。

表3.25 s2i-go タスクが返す結果
結果	タイプ	説明
`IMAGE_URL`	`string`	ビルドされたイメージの完全修飾名。
`IMAGE_DIGEST`	`string`	ビルドされたイメージのダイジェスト。

s2i-go ClusterTask からの変更点

新しいパラメーターが複数追加されました。
BASE_IMAGE パラメーターが削除されました。
パラメーター名 PATH_CONTEXT が CONTEXT に変更されました。
パラメーター名 TLS_VERIFY が TLSVERIFY に変更されました。
IMAGE_URL の結果が追加されました。

s2i-java

s2i-java タスクは、OpenShift Container Platform レジストリーから image-registry.openshift-image-registry.svc:5000/openshift/java として入手できる S2I Java ビルダーイメージを使用してソースコードをビルドします。

表3.26 s2i-java タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`IMAGE`	S2I プロセスがビルドするコンテナーイメージの完全修飾名。	`string`
`IMAGE_SCRIPTS_URL`	ビルダーイメージのデフォルトのアセンブルおよび実行スクリプトを含む URL。	`string`	`image:///usr/libexec/s2i`
`ENV_VARS`	ビルドプロセスで設定する環境変数の値の配列。`KEY=VALUE` 形式でリストされます。	`array`
`CONTEXT`	コンテキストとして使用する `source` ワークスペース内のディレクトリーへのパス。	`string`	`.`
`STORAGE_DRIVER`	Buildah ストレージドライバーを設定して、現在のクラスターノード設定を反映します。	`string`	`vfs`
`FORMAT`	ビルドするコンテナーの形式。`oci` または `docker` のいずれかです。	`string`	`oci`
`BUILD_EXTRA_ARGS`	イメージをビルドするときの `build` コマンドの追加パラメーター。	`string`
`PUSH_EXTRA_ARGS`	イメージをプッシュするときの `push` コマンドの追加パラメーター。	`string`
`SKIP_PUSH`	コンテナーレジストリーへのイメージのプッシュをスキップします。	`string`	`false`
`TLS_VERIFY`	TLS 検証フラグ。通常は `true` です。	`string`	`true`
`VERBOSE`	詳細なロギングをオンにすると、実行されたすべてのコマンドがログに追加されます。	`string`	`false`
`VERSION`	言語バージョンに対応するイメージストリームのタグ。	`string`	`latest`

表3.27 s2i-java タスクでサポートされているワークスペース
ワークスペース	説明
`source`	S2I ワークフローのビルドコンテキストであるアプリケーションソースコード。
`dockerconfig`	Buildah がコンテナーレジストリーへのアクセスに使用する `.docker/config.json` ファイルを提供するためのオプションワークスペース。ファイルを `config.json` または `.dockerconfigjson` という名前のワークスペースの root に配置します。

表3.28 s2i-java タスクが返す結果
結果	タイプ	説明
`IMAGE_URL`	`string`	ビルドされたイメージの完全修飾名。
`IMAGE_DIGEST`	`string`	ビルドされたイメージのダイジェスト。

s2i-java ClusterTask からの変更点

新しいパラメーターが複数追加されました。
BUILDER_IMAGE、MAVEN_ARGS_APPEND、MAVEN_CLEAR_REPO、および MAVEN_MIRROR_URL パラメーターが削除されました。MAVEN_ARGS_APPEND、MAVEN_CLEAR_REPO および MAVEN_MIRROR_URL の値を環境変数として渡すことができます。
パラメーター名 PATH_CONTEXT が CONTEXT に変更されました。
パラメーター名 TLS_VERIFY が TLSVERIFY に変更されました。
IMAGE_URL の結果が追加されました。

s2i-nodejs

s2i-nodejs タスクは、OpenShift Container Platform レジストリーから image-registry.openshift-image-registry.svc:5000/openshift/nodejs として入手できる S2I NodeJS ビルダーイメージを使用してソースコードをビルドします。

s2i-nodejs タスクの使用例

apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: build-and-deploy
spec:
# ...
  tasks:
# ...
  - name: build-s2i
    taskRef:
      resolver: cluster
      params:
      - name: kind
        value: task
      - name: name
        value: s2i-nodejs
      - name: namespace
        value: openshift-pipelines
    workspaces:
    - name: source
      workspace: shared-workspace
# ...

表3.29 s2i-nodejs タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`IMAGE`	S2I プロセスがビルドするコンテナーイメージの完全修飾名。	`string`
`IMAGE_SCRIPTS_URL`	ビルダーイメージのデフォルトのアセンブルおよび実行スクリプトを含む URL。	`string`	`image:///usr/libexec/s2i`
`ENV_VARS`	ビルドプロセスで設定する環境変数の値の配列。`KEY=VALUE` 形式でリストされます。	`array`
`CONTEXT`	コンテキストとして使用する `source` ワークスペース内のディレクトリーへのパス。	`string`	`.`
`STORAGE_DRIVER`	Buildah ストレージドライバーを設定して、現在のクラスターノード設定を反映します。	`string`	`vfs`
`FORMAT`	ビルドするコンテナーの形式。`oci` または `docker` のいずれかです。	`string`	`oci`
`BUILD_EXTRA_ARGS`	イメージをビルドするときの `build` コマンドの追加パラメーター。	`string`
`PUSH_EXTRA_ARGS`	イメージをプッシュするときの `push` コマンドの追加パラメーター。	`string`
`SKIP_PUSH`	コンテナーレジストリーへのイメージのプッシュをスキップします。	`string`	`false`
`TLS_VERIFY`	TLS 検証フラグ。通常は `true` です。	`string`	`true`
`VERBOSE`	詳細なロギングをオンにすると、実行されたすべてのコマンドがログに追加されます。	`string`	`false`
`VERSION`	言語バージョンに対応するイメージストリームのタグ。	`string`	`latest`

表3.30 s2i-nodejs タスクでサポートされているワークスペース
ワークスペース	説明
`source`	S2I ワークフローのビルドコンテキストであるアプリケーションソースコード。
`dockerconfig`	Buildah がコンテナーレジストリーへのアクセスに使用する `.docker/config.json` ファイルを提供するためのオプションワークスペース。ファイルを `config.json` または `.dockerconfigjson` という名前のワークスペースの root に配置します。

表3.31 s2i-nodejs タスクが返す結果
結果	タイプ	説明
`IMAGE_URL`	`string`	ビルドされたイメージの完全修飾名。
`IMAGE_DIGEST`	`string`	ビルドされたイメージのダイジェスト。

s2i-nodejs ClusterTask からの変更点

新しいパラメーターが複数追加されました。
BASE_IMAGE パラメーターが削除されました。
パラメーター名 PATH_CONTEXT が CONTEXT に変更されました。
パラメーター名 TLS_VERIFY が TLSVERIFY に変更されました。
IMAGE_URL の結果が追加されました。

s2i-perl

s2i-perl タスクは、OpenShift Container Platform レジストリーから image-registry.openshift-image-registry.svc:5000/openshift/perl として入手できる S2I Perl ビルダーイメージを使用してソースコードをビルドします。

s2i-perl タスクの使用例

apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: build-and-deploy
spec:
# ...
  tasks:
# ...
  - name: build-s2i
    taskRef:
      resolver: cluster
      params:
      - name: kind
        value: task
      - name: name
        value: s2i-perl
      - name: namespace
        value: openshift-pipelines
    workspaces:
    - name: source
      workspace: shared-workspace
# ...

表3.32 s2i-perl タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`IMAGE`	S2I プロセスがビルドするコンテナーイメージの完全修飾名。	`string`
`IMAGE_SCRIPTS_URL`	ビルダーイメージのデフォルトのアセンブルおよび実行スクリプトを含む URL。	`string`	`image:///usr/libexec/s2i`
`ENV_VARS`	ビルドプロセスで設定する環境変数の値の配列。`KEY=VALUE` 形式でリストされます。	`array`
`CONTEXT`	コンテキストとして使用する `source` ワークスペース内のディレクトリーへのパス。	`string`	`.`
`STORAGE_DRIVER`	Buildah ストレージドライバーを設定して、現在のクラスターノード設定を反映します。	`string`	`vfs`
`FORMAT`	ビルドするコンテナーの形式。`oci` または `docker` のいずれかです。	`string`	`oci`
`BUILD_EXTRA_ARGS`	イメージをビルドするときの `build` コマンドの追加パラメーター。	`string`
`PUSH_EXTRA_ARGS`	イメージをプッシュするときの `push` コマンドの追加パラメーター。	`string`
`SKIP_PUSH`	コンテナーレジストリーへのイメージのプッシュをスキップします。	`string`	`false`
`TLS_VERIFY`	TLS 検証フラグ。通常は `true` です。	`string`	`true`
`VERBOSE`	詳細なロギングをオンにすると、実行されたすべてのコマンドがログに追加されます。	`string`	`false`
`VERSION`	言語バージョンに対応するイメージストリームのタグ。	`string`	`latest`

表3.33 s2i-perl タスクでサポートされているワークスペース
ワークスペース	説明
`source`	S2I ワークフローのビルドコンテキストであるアプリケーションソースコード。
`dockerconfig`	Buildah がコンテナーレジストリーへのアクセスに使用する `.docker/config.json` ファイルを提供するためのオプションワークスペース。ファイルを `config.json` または `.dockerconfigjson` という名前のワークスペースの root に配置します。

表3.34 s2i-perl タスクが返す結果
結果	タイプ	説明
`IMAGE_URL`	`string`	ビルドされたイメージの完全修飾名。
`IMAGE_DIGEST`	`string`	ビルドされたイメージのダイジェスト。

s2i-perl ClusterTask からの変更点

新しいパラメーターが複数追加されました。
BASE_IMAGE パラメーターが削除されました。
パラメーター名 PATH_CONTEXT が CONTEXT に変更されました。
パラメーター名 TLS_VERIFY が TLSVERIFY に変更されました。
IMAGE_URL の結果が追加されました。

s2i-php

s2i-php タスクは、OpenShift Container Platform レジストリーから image-registry.openshift-image-registry.svc:5000/openshift/php として入手できる S2I PHP ビルダーイメージを使用してソースコードをビルドします。

s2i-php タスクの使用例

apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: build-and-deploy
spec:
# ...
  tasks:
# ...
  - name: build-s2i
    taskRef:
      resolver: cluster
      params:
      - name: kind
        value: task
      - name: name
        value: s2i-php
      - name: namespace
        value: openshift-pipelines
    workspaces:
    - name: source
      workspace: shared-workspace
# ...

表3.35 s2i-php タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`IMAGE`	S2I プロセスがビルドするコンテナーイメージの完全修飾名。	`string`
`IMAGE_SCRIPTS_URL`	ビルダーイメージのデフォルトのアセンブルおよび実行スクリプトを含む URL。	`string`	`image:///usr/libexec/s2i`
`ENV_VARS`	ビルドプロセスで設定する環境変数の値の配列。`KEY=VALUE` 形式でリストされます。	`array`
`CONTEXT`	コンテキストとして使用する `source` ワークスペース内のディレクトリーへのパス。	`string`	`.`
`STORAGE_DRIVER`	Buildah ストレージドライバーを設定して、現在のクラスターノード設定を反映します。	`string`	`vfs`
`FORMAT`	ビルドするコンテナーの形式。`oci` または `docker` のいずれかです。	`string`	`oci`
`BUILD_EXTRA_ARGS`	イメージをビルドするときの `build` コマンドの追加パラメーター。	`string`
`PUSH_EXTRA_ARGS`	イメージをプッシュするときの `push` コマンドの追加パラメーター。	`string`
`SKIP_PUSH`	コンテナーレジストリーへのイメージのプッシュをスキップします。	`string`	`false`
`TLS_VERIFY`	TLS 検証フラグ。通常は `true` です。	`string`	`true`
`VERBOSE`	詳細なロギングをオンにすると、実行されたすべてのコマンドがログに追加されます。	`string`	`false`
`VERSION`	言語バージョンに対応するイメージストリームのタグ。	`string`	`latest`

表3.36 s2i-php タスクでサポートされているワークスペース
ワークスペース	説明
`source`	S2I ワークフローのビルドコンテキストであるアプリケーションソースコード。
`dockerconfig`	Buildah がコンテナーレジストリーへのアクセスに使用する `.docker/config.json` ファイルを提供するためのオプションワークスペース。ファイルを `config.json` または `.dockerconfigjson` という名前のワークスペースの root に配置します。

表3.37 s2i-php タスクが返す結果
結果	タイプ	説明
`IMAGE_URL`	`string`	ビルドされたイメージの完全修飾名。
`IMAGE_DIGEST`	`string`	ビルドされたイメージのダイジェスト。

s2i-php ClusterTask からの変更点

新しいパラメーターが複数追加されました。
BASE_IMAGE パラメーターが削除されました。
パラメーター名 PATH_CONTEXT が CONTEXT に変更されました。
パラメーター名 TLS_VERIFY が TLSVERIFY に変更されました。
IMAGE_URL の結果が追加されました。

s2i-python

s2i-python タスクは、OpenShift Container Platform レジストリーから image-registry.openshift-image-registry.svc:5000/openshift/Python として入手できる S2I Python ビルダーイメージを使用してソースコードをビルドします。

s2i-python タスクの使用例

apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: build-and-deploy
spec:
# ...
  tasks:
# ...
  - name: build-s2i
    taskRef:
      resolver: cluster
      params:
      - name: kind
        value: task
      - name: name
        value: s2i-python
      - name: namespace
        value: openshift-pipelines
    workspaces:
    - name: source
      workspace: shared-workspace
# ...

表3.38 s2i-python タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`IMAGE`	S2I プロセスがビルドするコンテナーイメージの完全修飾名。	`string`
`IMAGE_SCRIPTS_URL`	ビルダーイメージのデフォルトのアセンブルおよび実行スクリプトを含む URL。	`string`	`image:///usr/libexec/s2i`
`ENV_VARS`	ビルドプロセスで設定する環境変数の値の配列。`KEY=VALUE` 形式でリストされます。	`array`
`CONTEXT`	コンテキストとして使用する `source` ワークスペース内のディレクトリーへのパス。	`string`	`.`
`STORAGE_DRIVER`	Buildah ストレージドライバーを設定して、現在のクラスターノード設定を反映します。	`string`	`vfs`
`FORMAT`	ビルドするコンテナーの形式。`oci` または `docker` のいずれかです。	`string`	`oci`
`BUILD_EXTRA_ARGS`	イメージをビルドするときの `build` コマンドの追加パラメーター。	`string`
`PUSH_EXTRA_ARGS`	イメージをプッシュするときの `push` コマンドの追加パラメーター。	`string`
`SKIP_PUSH`	コンテナーレジストリーへのイメージのプッシュをスキップします。	`string`	`false`
`TLS_VERIFY`	TLS 検証フラグ。通常は `true` です。	`string`	`true`
`VERBOSE`	詳細なロギングをオンにすると、実行されたすべてのコマンドがログに追加されます。	`string`	`false`
`VERSION`	言語バージョンに対応するイメージストリームのタグ。	`string`	`latest`

表3.39 s2i-python タスクでサポートされているワークスペース
ワークスペース	説明
`source`	S2I ワークフローのビルドコンテキストであるアプリケーションソースコード。
`dockerconfig`	Buildah がコンテナーレジストリーへのアクセスに使用する `.docker/config.json` ファイルを提供するためのオプションワークスペース。ファイルを `config.json` または `.dockerconfigjson` という名前のワークスペースの root に配置します。

表3.40 s2i-python タスクが返す結果
結果	タイプ	説明
`IMAGE_URL`	`string`	ビルドされたイメージの完全修飾名。
`IMAGE_DIGEST`	`string`	ビルドされたイメージのダイジェスト。

s2i-python ClusterTask からの変更点

新しいパラメーターが複数追加されました。
BASE_IMAGE パラメーターが削除されました。
パラメーター名 PATH_CONTEXT が CONTEXT に変更されました。
パラメーター名 TLS_VERIFY が TLSVERIFY に変更されました。
IMAGE_URL の結果が追加されました。

s2i-ruby

s2i-ruby タスクは、OpenShift Container Platform レジストリーから image-registry.openshift-image-registry.svc:5000/openshift/ruby として入手できる S2I Ruby ビルダーイメージを使用してソースコードをビルドします。

s2i-ruby タスクの使用例

apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: build-and-deploy
spec:
# ...
  tasks:
# ...
  - name: build-s2i
    taskRef:
      resolver: cluster
      params:
      - name: kind
        value: task
      - name: name
        value: s2i-ruby
      - name: namespace
        value: openshift-pipelines
    workspaces:
    - name: source
      workspace: shared-workspace
# ...

表3.41 s2i-ruby タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`IMAGE`	S2I プロセスがビルドするコンテナーイメージの完全修飾名。	`string`
`IMAGE_SCRIPTS_URL`	ビルダーイメージのデフォルトのアセンブルおよび実行スクリプトを含む URL。	`string`	`image:///usr/libexec/s2i`
`ENV_VARS`	ビルドプロセスで設定する環境変数の値の配列。`KEY=VALUE` 形式でリストされます。	`array`
`CONTEXT`	コンテキストとして使用する `source` ワークスペース内のディレクトリーへのパス。	`string`	`.`
`STORAGE_DRIVER`	Buildah ストレージドライバーを設定して、現在のクラスターノード設定を反映します。	`string`	`vfs`
`FORMAT`	ビルドするコンテナーの形式。`oci` または `docker` のいずれかです。	`string`	`oci`
`BUILD_EXTRA_ARGS`	イメージをビルドするときの `build` コマンドの追加パラメーター。	`string`
`PUSH_EXTRA_ARGS`	イメージをプッシュするときの `push` コマンドの追加パラメーター。	`string`
`SKIP_PUSH`	コンテナーレジストリーへのイメージのプッシュをスキップします。	`string`	`false`
`TLS_VERIFY`	TLS 検証フラグ。通常は `true` です。	`string`	`true`
`VERBOSE`	詳細なロギングをオンにすると、実行されたすべてのコマンドがログに追加されます。	`string`	`false`
`VERSION`	言語バージョンに対応するイメージストリームのタグ。	`string`	`latest`

表3.42 s2i-ruby タスクでサポートされているワークスペース
ワークスペース	説明
`source`	S2I ワークフローのビルドコンテキストであるアプリケーションソースコード。
`dockerconfig`	Buildah がコンテナーレジストリーへのアクセスに使用する `.docker/config.json` ファイルを提供するためのオプションワークスペース。ファイルを `config.json` または `.dockerconfigjson` という名前のワークスペースの root に配置します。

表3.43 s2i-ruby タスクが返す結果
結果	タイプ	説明
`IMAGE_URL`	`string`	ビルドされたイメージの完全修飾名。
`IMAGE_DIGEST`	`string`	ビルドされたイメージのダイジェスト。

s2i-ruby ClusterTask からの変更点

新しいパラメーターが複数追加されました。
BASE_IMAGE パラメーターが削除されました。
パラメーター名 PATH_CONTEXT が CONTEXT に変更されました。
パラメーター名 TLS_VERIFY が TLSVERIFY に変更されました。
IMAGE_URL の結果が追加されました。

skopeo-copy

skopeo-copy タスクは skopeo copy コマンドを実行します。

Skopeo は、リモートコンテナーイメージレジストリーを操作するためのコマンドラインツールであり、イメージのロードや実行にデーモンやその他のインフラストラクチャーを必要としません。skopeo copy コマンドは、別のリモートレジストリーにイメージをコピーします (たとえば、内部レジストリーから実稼働レジストリーにコピーします)。Skopeo は、ユーザーが提供する認証情報を使用したイメージレジストリーでの認可をサポートします。

skopeo-copy タスクの使用例

apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: build-deploy-image
spec:
# ...
  tasks:
  - name: copy-image
    taskRef:
      resolver: cluster
      params:
      - name: kind
        value: task
      - name: name
        value: skopeo-copy
      - name: namespace
        value: openshift-pipelines
    params:
    - name: SOURCE_IMAGE_URL
      value: "docker://internal.registry/myimage:latest"
    - name: DESTINATION_IMAGE_URL
      value: "docker://production.registry/myimage:v1.0"
    workspaces:
    - name: output
      workspace: shared-workspace

表3.44 skopeo-copy タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`SOURCE_IMAGE_URL`	ソースコンテナーイメージのタグを含む完全修飾名。	`string`
`DESTINATION_IMAGE_URL`	Skopeo がソースイメージをコピーする宛先イメージの、タグを含む完全修飾名。	`string`
`SRC_TLS_VERIFY`	ソースレジストリーの TLS 検証フラグ。通常は `true` です。	`string`	`true`
`DEST_TLS_VERIFY`	宛先レジストリーの TLS 検証フラグ。通常は `true` です。	`string`	`true`
`VERBOSE`	デバッグ情報をログに出力します。	`string`	`false`

表3.45 skopeo-copy タスクでサポートされているワークスペース
ワークスペース	説明
`images_url`	複数のイメージをコピーする場合は、このワークスペースを使用してイメージの URL を指定します。

表3.46 skopeo-copy タスクが返す結果
結果	タイプ	説明
`SOURCE_DIGEST`	`string`	ソースイメージの SHA256 ダイジェスト。
`DESTINATION_DIGEST`	`string`	宛先イメージの SHA256 ダイジェスト。

skopeo-copy ClusterTask からの変更点

すべてのパラメーター名が大文字に変更されました。
VERBOSE パラメーターが追加されました。
ワークスペース名が images-url から images_url に変更されました。
SOURCE_DIGEST および DESTINATION_DIGEST の結果が追加されました。

tkn

tkn タスクは、tkn を使用して Tekton リソースに対して操作を実行します。

tkn タスクの使用例

apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
 name: tkn-run
spec:
 pipelineSpec:
   tasks:
   - name: tkn-run
     taskRef:
       resolver: cluster
       params:
       - name: kind
         value: task
       - name: name
         value: tkn
       - name: namespace
         value: openshift-pipelines
     params:
     - name: ARGS

表3.47 tkn タスクでサポートされているパラメーター
パラメーター	説明	タイプ	デフォルト値
`SCRIPT`	実行する `tkn` CLI スクリプト。	`string`	`tkn $@`
`ARGS`	実行する `tkn` CLI 引数。	`array`	`- --help`

表3.48 tkn タスクでサポートされているワークスペース
ワークスペース	説明
`kubeconfig_dir`	クラスターにアクセスするための認証情報を含む `.kube/config` ファイルを提供できるオプションのワークスペース。このファイルをワークスペースのルートに配置し、`kubeconfig` という名前を付けます。

tkn ClusterTask からの変更点

TKN_IMAGE パラメーターが削除されました。
ワークスペース名が kubeconfig から kubeconfig_dir に変更されました。