検索

3.3. Red Hat OpenShift Pipelines コントロールプレーンの設定

download PDF

TektonConfig カスタムリソース (CR) の設定フィールドを編集して、OpenShift Pipelines コントロールプレーンをカスタマイズできます。Red Hat OpenShift Pipelines Operator は設定フィールドにデフォルト値を自動的に追加し、OpenShift Pipelines コントロールプレーンを使用可能な状態にします。

手順

  1. Web コンソールの Administrator パースペクティブで、Administration CustomResourceDefinitions に移動します。
  2. Search by name ボックスを使用して、tektonconfigs.operator.tekton.dev カスタムリソース定義 (CRD) を検索します。TektonConfig をクリックし、CRD の詳細ページを表示します。
  3. Instances タブをクリックします。
  4. config インスタンスをクリックして、TektonConfig CR の詳細を表示します。
  5. YAML タブをクリックします。
  6. 要件に応じて TektonConfig YAML ファイルを編集します。

    デフォルト値が適用された TektonConfig CR の例

    apiVersion: operator.tekton.dev/v1alpha1
    kind: TektonConfig
    metadata:
      name: config
    spec:
      pipeline:
        running-in-environment-with-injected-sidecars: true
        metrics.taskrun.duration-type: histogram
        metrics.pipelinerun.duration-type: histogram
        await-sidecar-readiness: true
        params:
          - name: enableMetrics
            value: 'true'
        default-service-account: pipeline
        require-git-ssh-secret-known-hosts: false
        enable-tekton-oci-bundles: false
        metrics.taskrun.level: task
        metrics.pipelinerun.level: pipeline
        enable-api-fields: stable
        enable-provenance-in-status: false
        enable-custom-tasks: true
        disable-creds-init: false
        disable-affinity-assistant: true

3.3.1. デフォルト値が適用された変更可能フィールド

次のリストには、デフォルト値が適用された TektonConfig CR の変更可能フィールドがすべて含まれています。

  • running-in-environment-with-injected-sidecars (デフォルト: true): Istio などの注入済みサイドカーを使用しないクラスターでパイプラインを実行する場合は、このフィールドを false に設定します。false に設定すると、パイプラインがタスク実行を開始するまでにかかる時間が短縮されます。

    注記

    注入されたサイドカーを使用するクラスターの場合、このフィールドを false に設定すると、予期しない動作が発生する可能性があります。

  • await-sidecar-readiness (デフォルト: true): TaskRun サイドカーコンテナーの実行を待たずに OpenShift が動作を開始するようにするには、このフィールドを false に設定します。これにより、downwardAPI ボリュームタイプをサポートしない環境でのタスク実行が可能になります。
  • default-service-account (デフォルト: Pipeline): 特に指定されていない場合、このフィールドには TaskRun および PipelineRun リソースに使用するデフォルトのサービスアカウント名が設定されます。
  • require-git-ssh-secret-known-hosts (デフォルト: false): このフィールドを true に設定するには、Git SSH シークレットに known_hosts フィールドが含まれている必要があります。

    • Git SSH シークレットの設定の詳細は、関連情報 セクションの Git の SSH 認証の設定 を参照してください。
  • enable-tekton-oci-bundles (デフォルト: false): このフィールドを true に設定すると、Tekton OCI バンドルという名前の実験的アルファ機能の使用が可能になります。
  • enable-api-fields (デフォルト: stable): このフィールドを設定すると、どの機能が有効になるかが決まります。使用できる値はは stablebeta、または alpha です。

    注記

    Red Hat OpenShift Pipelines で alpha 値はサポートされていません。

  • enable-provenance-in-status (デフォルト: false): このフィールドを true に設定すると、TaskRun ステータスおよび PipelineRun ステータスの provenance フィールドへの入力が可能になります。provenance フィールドには、リモートタスクまたはパイプライン定義の取得元などの、タスク実行およびパイプライン実行で使用されるリソースのメタデータが含まれます。
  • enable-custom-tasks (デフォルト: true): このフィールドを false に設定すると、パイプラインでのカスタムタスクの使用が無効になります。
  • disable-creds-init (デフォルト: false): OpenShift Pipelines が接続されたサービスアカウントをスキャンしてステップに認証情報を挿入しないようにするには、このフィールドを true に設定します。
  • disable-affinity-assistant (デフォルト: true): 永続ボリューム要求ワークスペースを共有する各 TaskRun リソースに対してアフィニティーアシスタントを有効にするには、このフィールドを false に設定します。

メトリクスオプション

TektonConfig CR の次のメトリクスフィールドのデフォルト値を変更できます。

  • metrics.taskrun.duration-typemetrics.pipelinerun.duration-type (デフォルト: histogram): これらのフィールドを設定すると、タスクまたはパイプライン実行の期間のタイプが決まります。使用できる値は、gauge または histogram です。
  • metrics.taskrun.level (デフォルト: task): このフィールドにより、タスク実行メトリクスのレベルが決まります。使用できる値は、taskruntask、または namespace です。
  • metrics.pipelinerun.level (デフォルト: pipeline): このフィールドにより、パイプライン実行メトリクスのレベルが決まります。使用できる値は、pipelinerunpipeline、または namespace です。

3.3.2. 任意の設定フィールド

次のフィールドにはデフォルト値がなく、設定した場合にのみ考慮されます。デフォルトでは、Operator はこれらのフィールドを TektonConfig カスタムリソース (CR) に追加も設定もしません。

  • default-timeout-minutes: TaskRun および PipelineRun リソースの作成時に指定していない場合、このフィールドがデフォルトのタイムアウトを設定します。タスク実行またはパイプライン実行にかかる時間が設定された分数より長いと、タスク実行またはパイプライン実行はタイムアウトになり、キャンセルされます。たとえば、default-timeout-minutes: 60 はデフォルトを 60 分に設定します。
  • default-managed-by-label-value: このフィールドには、app.kubernetes.io/managed-by ラベルに指定されたデフォルト値が含まれます。このデフォルト値は、何も指定されていない場合にすべての TaskRun Pod に適用されます。たとえば、default-managed-by-label-value: tekton-pipelines です。
  • default-pod-template: このフィールドは、指定されていない場合にデフォルトの TaskRun および PipelineRun Pod テンプレートを設定します。
  • default-cloud-events-sink: このフィールドは、何も指定されていない場合に、TaskRun および PipelineRun リソースに使用されるデフォルトの CloudEvents シンクを設定します。
  • default-task-run-workspace-binding: このフィールドには、Task リソースが宣言するワークスペースのデフォルトワークスペース設定が含まれますが、TaskRun リソースは明示的に宣言されません。
  • default-affinity-assistant-pod-template: このフィールドは、何も指定されていない場合にアフィニティーアシスタント Pod が使用するデフォルトの PipelineRun Pod テンプレートを設定します。
  • default-max-matrix-combinations-count: このフィールドには、何も指定されていない場合の、マトリクスから生成される組み合わせの最大数のデフォルト値が含まれます。
Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

© 2024 Red Hat, Inc.