1.4. パイプライン実行とタスク実行の名前で結果とログのクエリーを実行する

前提条件

• opc ユーティリティーがインストールされている。
• OpenShift CLI (oc) を使用して OpenShift Container Platform クラスターにログオンした。

検証

• 次のコマンドを入力して、opc ユーティリティーに設定した設定を表示できます。

  $ opc results config view

  出力例

  api-path: ""
  apiVersion: results.tekton.dev/v1alpha2
  host: https://tekton-results.openshiftapps.com
  insecure-skip-tls-verify: "true"
  kind: Client
  token: sha256~xyz

前提条件

• opc ユーティリティーがインストールされている。
• パイプライン実行とタスク実行の名前で Tekton Results に結果のクエリーを実行するように opc ユーティリティーを設定した。

手順

• 次のいずれかのコマンドを使用して、パイプライン実行を表示します。

  • 指定された namespace 内のすべてのパイプライン実行を表示するには、次のコマンドを入力します。

    $ opc results pipelinerun list -n <namespace_name>

    必要に応じて、--limit コマンドラインオプション (例: --limit=10) を指定します。この設定では、opc コマンドは指定された行数 (パイプライン実行名を含む) を表示し、終了します。--single-page=false コマンドラインオプションを追加すると、コマンドは指定された行数を表示し、続行するか終了するかを尋ねるプロンプトが表示されます。

    必要に応じて、--labels コマンドラインオプション (例: --labels="app.kubernetes.io/name=test-app, app.kubernetes.io/component=database) を指定します。この設定では、リストには指定されたラベルまたはアノテーションを持つパイプライン実行のみが含まれます。

    opc results pipelinerun list コマンドの出力例

    NAME                                           UID                                    STARTED      DURATION   STATUS
    openshift-pipelines-main-release-tests-zscq8   78515e3a-8e20-43e8-a064-d2442c2ae845   1 week ago   5s         Failed(CouldntGetPipeline)
    openshift-pipelines-main-release-tests-zrgv6   14226144-2d08-440d-a600-d602ca46cdf6   1 week ago   26m13s     Failed
    openshift-pipelines-main-release-tests-jdc24   e34daea2-66fb-4c7d-9d4b-d9d82a07b6cd   1 week ago   5s         Failed(CouldntGetPipeline)
    openshift-pipelines-main-release-tests-6zj7f   9b3e5d68-70ab-4c23-8872-e7ad7121e60b   1 week ago   5s         Failed(CouldntGetPipeline)
    openshift-pipelines-main-release-tests-kkk9t   2fd28c48-388b-4e6a-9ec3-2bcd9dedebc3   1 week ago   5s         Failed(CouldntGetPipeline)

  • 指定された名前付きパイプラインに関連するパイプライン実行を表示するには、次のコマンドを入力します。

    $ opc results pipelinerun list <pipeline_name> -n <namespace_name>

    このコマンドを実行すると、名前に <pipeline_name> が含まれるパイプラインのすべてのパイプライン実行がリスト表示されます。たとえば、build を指定すると、コマンドは build、build_123、または enhancedbuild という名前のパイプラインに関連するすべてのパイプライン実行を表示します。

    必要に応じて、--limit コマンドラインオプション (例: --limit=10) を指定します。この設定では、opc コマンドは指定された行数 (パイプライン実行名を含む) を表示し、終了します。--single-page=false コマンドラインオプションを追加すると、コマンドは指定された行数を表示し、続行するか終了するかを尋ねるプロンプトが表示されます。

前提条件

• opc ユーティリティーがインストールされている。
• パイプライン実行とタスク実行の名前で Tekton Results に結果のクエリーを実行するように opc ユーティリティーを設定した。

手順

• namespace 内のすべてのタスク実行のリストを表示するには、次のコマンドを入力します。

  $ opc results taskrun list -n <namespace_name>

  必要に応じて、--limit コマンドラインオプション (例: --limit=10) を指定します。この設定では、opc コマンドは指定された行数 (パイプライン実行名を含む) を表示し、終了します。--single-page=false コマンドラインオプションを追加すると、コマンドは指定された行数を表示し、続行するか終了するかを尋ねるプロンプトが表示されます。

  必要に応じて、--labels パラメーター (例: --labels="app.kubernetes.io/name=test-app, app.kubernetes.io/component=database) を指定します。この設定では、リストには指定されたラベルまたはアノテーションを持つタスク実行のみが含まれます。

  namespace の opc results pipelinerun list コマンドの出力例

  NAME                                           UID                                    STARTED      DURATION   STATUS
  openshift-pipelines-main-release-tests-zrgv6-e2e-test             10d6952f-b926-4e4b-a976-519867969ce7   16d ago   12m41s     Failed
  openshift-pipelines-main-release-tests-zrgv6-deploy-operator      ab41b63b-16ec-4a32-8b95-f2678eb5c945   16d ago   22s        Succeeded
  openshift-pipelines-main-release-tests-zrgv6-provision-cluster    b374df00-5132-4633-91df-3259670756b3   16d ago   12m30s     Succeeded
  operator-main-index-4-18-on-pull-request-ml4ww-show-sbom          c5b77784-cd87-4be8-bc12-28957762f382   16d ago   16s        Succeeded
  openshift-c4ae3a5a28e19ffc930e7c2aa758d85c-provision-eaas-space   22535d8e-d360-4143-9c0c-4bd0414a22b0   16d ago   17s        Succeeded

• パイプライン実行に関連付けられたタスク実行のリストを表示するには、次のコマンドを入力します。

  $ opc results taskrun list --pipelinerun <pipelinerun_name> -n <namespace_name>

  必要に応じて、--limit コマンドラインオプション (例: --limit=10) を指定します。この設定では、opc コマンドは指定された行数 (パイプライン実行名を含む) を表示し、終了します。--single-page=false コマンドラインオプションを追加すると、コマンドは指定された行数を表示し、続行するか終了するかを尋ねるプロンプトが表示されます。

前提条件

• opc ユーティリティーがインストールされている。
• パイプライン実行とタスク実行の名前で Tekton Results に結果のクエリーを実行するように opc ユーティリティーを設定した。
• パイプライン実行の名前または UUID を持っている。ocp results list pipelineruns コマンドを使用して、結果が利用可能なパイプライン実行の名前と UUID を表示できます。

手順

• 次のいずれかのコマンドを使用して、パイプライン実行の結果情報を表示します。

  • パイプラインの実行がいつ、どのように完了したかの説明を表示するには、次のコマンドを入力します。

    $ opc results pipelinerun describe -n <namespace_name> <pipelinerun_name>

    または、名前の代わりにパイプライン実行の UUID を使用することもできます。

    $ opc results pipelinerun describe -n <namespace_name> --uid <pipelinerun_uuid>

    opc results pipelinerun describe コマンドの出力例

    Name: operator-main-index-4-18-on-pull-request-7kssl
    Namespace: tekton-ecosystem-tenant
    Service Account: appstudio-pipeline
    Labels:
     app.kubernetes.io/managed-by=pipelinesascode.tekton.dev
     app.kubernetes.io/version=v0.33.0
    Annotations:
     appstudio.openshift.io/snapshot=openshift-pipelines-main-b7jj6
     build.appstudio.openshift.io/repo=https://github.com/openshift-pipelines/operator?rev=ba5e62e51af0c88bc6c3fd4201e789bdfc093daa
    
    📌 Status
    STARTED          DURATION         STATUS
    27d ago          9m54s            Succeeded
    
    ⏱ Timeouts
    Pipeline:   2h0m0s
    
    ⚓ Params
      NAME                          VALUE
      • git-url                     https://github.com/pramodbindal/operator
      • revision                    ba5e62e51af0c88bc6c3fd4201e789bdfc093daa
    
    🗂  Workspaces
      NAME                SUB PATH            WORKSPACE BINDING
      • workspace          ---                VolumeClaimTemplate
      • git-auth           ---                Secret (secret=pac-gitauth-ceqzjt)
    
    📦 Taskruns
      NAME                                                                         TASK NAME
      • operator-main-index-4-18-on-pull-request-7kssl-init                        init
      • operator-main-index-4-18-on-pull-request-7kssl-clone-repository            clone-repository

• パイプライン実行の完全な YAML マニフェストを表示するには、次のコマンドを入力します。

  $ opc results pipelinerun describe -n <namespace_name> --output yaml <pipelinerun_name>

  または、名前の代わりにパイプライン実行の UUID を使用することもできます。

  $ opc results pipelinerun describe -n <namespace_name> --output yaml --uid <pipelinerun_uuid>

• パイプラインの実行に関連付けられたログを表示するには、次のコマンドを入力します。

  $ opc results pipelinerun logs -n <namespace_name> <pipelinerun_name>

  または、名前の代わりにパイプライン実行の UUID を使用することもできます。

  $ opc results pipelinerun logs -n <namespace_name> --uid <pipelinerun_uuid>

前提条件

• opc ユーティリティーがインストールされている。
• パイプライン実行とタスク実行の名前で Tekton Results に結果のクエリーを実行するように opc ユーティリティーを設定した。
• タスク実行の名前または UUID を持っている。opc results taskrun list コマンドを使用すると、結果が利用可能なタスク実行の名前または UUID を表示できます。
• ログを LokiStack に転送するように設定した (ログを取得する場合)。

手順

• 次のいずれかのコマンドを使用して、タスク実行の結果情報を表示します。

  • タスク実行がいつ、どのように完了したかの説明を表示するには、次のコマンドを入力します。

    $ opc results taskrun describe -n <namespace_name> <taskrun_name>

    または、名前の代わりにタスク実行の UUID を使用することもできます。

    $ opc results taskrun describe -n <namespace_name> --uid <taskrun_uuid>

    opc results taskrun describe コマンドの出力例

    Name: operator-main-index-4-18-on-push-gc699-build-images-0
    Namespace: tekton-ecosystem-tenant
    Service Account: appstudio-pipeline
    Labels:
     tekton.dev/pipelineTask=build-images
     tekton.dev/task=buildah-remote-oci-ta
    Annotations:
     pipelinesascode.tekton.dev/branch=main
     pipelinesascode.tekton.dev/check-run-id=40080193061
    
    📌 Status
    STARTED          DURATION         STATUS
    28d ago          3m22s            Failed
    
    ⚓ Params
      NAME                          VALUE
      • PLATFORM                    linux-m2xlarge/arm64
      • IMAGE                       quay.io/redhat-user-workloads/tekton-ecosystem

• タスク実行の完全な YAML マニフェストを表示するには、次のコマンドを入力します。

  $ opc results taskrun describe -n <namespace_name> --output yaml <taskrun_name>

  または、名前の代わりにタスク実行の UUID を使用することもできます。

  $ opc results taskrun describe -n <namespace_name> --output yaml --uid <taskrun_uuid>

• タスク実行に関連付けられたログを表示するには、次のコマンドを入力します。

  $ opc results taskrun logs -n <namespace_name> <taskrun_name>

  または、名前の代わりにタスク実行の UUID を使用することもできます。

  $ opc results taskrun logs -n <namespace_name> --uid <taskrun_uuid>