インストールおよび設定

手順

1. Web コンソールの Administrator パースペクティブで、Operators → OperatorHub に移動します。
2. Filter by keyword ボックスを使用して、カタログで Red Hat OpenShift Pipelines Operator を検索します。Red Hat OpenShift Pipelines Operator タイルをクリックします。
3. Red Hat OpenShift Pipelines Operator ページで Operator に関する簡単な説明を参照してください。Install をクリックします。

4. Install Operator ページで以下を行います。

   1. Installation Mode で All namespaces on the cluster (default) を選択します。このモードは、デフォルトの openshift-operators namespace に Operator をインストールします。これにより、Operator はクラスター内のすべての namespace を監視し、これらの namespace に対して利用可能になります。
   2. Approval Strategy で Automatic を選択します。これにより、Operator への今後のアップグレードは Operator Lifecycle Manager (OLM) に自動的に処理されます。Manual 承認ストラテジーを選択すると、OLM は更新要求を作成します。クラスター管理者は、Operator を新規バージョンに更新できるように OLM 更新要求を手動で承認する必要があります。

   3. Update Channel を選択します。

      • latest チャネルにより、Red Hat OpenShift Pipelines Operator の最新の stable バージョンがインストール可能になります。これは、Red Hat OpenShift Pipelines Operator のインストールに使用する現在のデフォルトチャネルです。

      • Red Hat OpenShift Pipelines Operator の特定のバージョンをインストールする場合、クラスター管理者は対応する pipelines-<version> チャネルを使用できます。たとえば、Red Hat OpenShift Pipelines Operator バージョン 1.8.x をインストールするには、pipelines-1.8 チャネルを使用できます。

        注記

        OpenShift Container Platform 4.11 以降、Red Hat OpenShift Pipelines Operator をインストールおよびアップグレードするための preview および stable チャネルは利用できません。ただし、OpenShift Container Platform 4.10 以前のバージョンでは、preview および stable チャネルを使用して Operator をインストールおよびアップグレードできます。

5. Install をクリックします。Operator が Installed Operators ページにリスト表示されます。

   注記

   Operator は openshift-operators namespace に自動的にインストールされます。

6. Status が Succeeded Up to date に設定されていることを確認し、Red Hat OpenShift Pipelines Operator が正常にインストールされたことを確かめます。

   警告

   他のコンポーネントのインストールが進行中の場合でも、成功ステータスが Succeeded Up to date として表示される場合があります。したがって、ターミナルで手動でインストールを確認することが重要です。

7. Red Hat OpenShift Pipelines Operator のすべてのコンポーネントが正常にインストールされたことを確認します。ターミナルでクラスターにログインし、次のコマンドを実行します。

   $ oc get tektonconfig config

   Copy to Clipboard Toggle word wrap

   出力例

   NAME     VERSION   READY   REASON
   config   1.20.0     True

   Copy to Clipboard Toggle word wrap

   READY 条件が True の場合は、Operator とそのコンポーネントが正常にインストールされています。

   さらに、次のコマンドを実行して、コンポーネントのバージョンを確認します。

   $ oc get tektonpipeline,tektontrigger,tektonchain,tektonaddon,pac

   Copy to Clipboard Toggle word wrap

   出力例

   NAME                                          VERSION   READY   REASON
   tektonpipeline.operator.tekton.dev/pipeline   v0.47.0   True
   
   NAME                                        VERSION   READY   REASON
   tektontrigger.operator.tekton.dev/trigger   v0.23.1   True
   
   NAME                                    VERSION   READY   REASON
   tektonchain.operator.tekton.dev/chain   v0.16.0   True
   
   NAME                                    VERSION   READY   REASON
   tektonaddon.operator.tekton.dev/addon   1.11.0     True
   
   NAME                                                             VERSION   READY   REASON
   openshiftpipelinesascode.operator.tekton.dev/pipelines-as-code   v0.19.0   True

   Copy to Clipboard Toggle word wrap

手順

1. Subscription オブジェクトの YAML ファイルを作成し、namespace を Red Hat OpenShift Pipelines Operator にサブスクライブします (例: sub.yaml)。

   Subscription YAML の例

   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: openshift-pipelines-operator
     namespace: openshift-operators
   spec:
     channel:  <channel_name> 

   1

   
     name: openshift-pipelines-operator-rh 

   2

   
     source: redhat-operators 

   3

   
     sourceNamespace: openshift-marketplace 

   4

   Copy to Clipboard Toggle word wrap

   1

   サブスクライブするチャネルの名前。デフォルトチャネルは pipelines-<version> です。たとえば、Red Hat OpenShift Pipelines Operator バージョン 1.7 のデフォルトチャネルは pipelines-1.7 です。latest チャネルにより、Red Hat OpenShift Pipelines Operator の最新の stable バージョンがインストール可能になります。

   2

   サブスクライブする Operator の名前。

   3

   Operator を提供する CatalogSource オブジェクトの名前。

   4

   CatalogSource オブジェクトの namespace。デフォルトの OperatorHub カタログソースには openshift-marketplace を使用します。

2. 以下のコマンドを実行して Subscription オブジェクトを作成します。

   $ oc apply -f sub.yaml

   Copy to Clipboard Toggle word wrap

   サブスクリプションにより、Red Hat OpenShift Pipelines Operator が openshift-operators namespace にインストールされます。Operator は、OpenShift Pipelines をデフォルトの openshift-pipelines ターゲット namespace に自動的にインストールします。

手順

1. Web コンソールの Administrator パースペクティブで、Administration → CustomResourceDefinitions に移動します。
2. Filter by name フィールドに TektonHub と入力して、TektonHub カスタムリソース定義 (CRD) を検索します。
3. TektonHub CRD の名前をクリックし、CRD の詳細ページを表示します。
4. Instances タブをクリックします。
5. インスタンスが表示されている場合は、表示されたインスタンスの Options メニュー をクリックします。
6. Delete TektonHub を選択します。
7. Delete をクリックし、CR の削除を確定します。
8. これらの手順を繰り返して、Filter by name ボックスで TektonResult を検索し、TektonConfig を検索します。これらの CRD のインスタンスが見つかった場合は、これらのインスタンスを削除します。

手順

1. Operators → OperatorHub ページから、Filter by keyword ボックスを使用して Red Hat OpenShift Pipelines Operator を検索します。
2. Red Hat OpenShift Pipelines Operator タイルをクリックします。Operator タイルは、Operator がインストールされていることを示します。
3. Red Hat OpenShift Pipelines Operator の説明ページで、Uninstall をクリックします。
4. Uninstall Operator? ウィンドウで、Delete all operand instances for this operator を選択し、Uninstall をクリックします。

手順

1. Web コンソールの Administrator パースペクティブで、Administration → CustomResourceDefinitions に移動します。
2. Filter by name ボックスに operator.tekton.dev と入力して、operator.tekton.dev グループ内の CRD を検索します。

3. 表示される各 CRD を削除するには、以下の手順を実行します。

   1. Options メニュー ( ) をクリックします。
   2. Delete CustomResourceDefinition を選択します。
   3. Delete をクリックし、CRD の削除を確定します。

手順

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

   Copy to Clipboard Toggle word wrap

手順

1. 次のコマンドを実行して、TektonConfig CR を編集します。

   $ oc edit TektonConfig config

   Copy to Clipboard Toggle word wrap

2. TektonConfig CR で、.addon.params 仕様の resolverTasks および pipelineTemplates パラメーター値を false に設定します。

   リゾルバータスクおよびパイプラインテンプレートリソースの無効化例

   apiVersion: operator.tekton.dev/v1alpha1
   kind: TektonConfig
   metadata:
     name: config
   spec:
   # ...
     addon:
       params:
         - name: resolverTasks
           value: 'false'
         - name: pipelineTemplates
           value: 'false'
   # ...

   Copy to Clipboard Toggle word wrap

   重要

   pipelinesTemplates パラメーターの値は、resolverTasks パラメーターの値が true の場合にのみ true に設定できます。

手順

1. 次のコマンドを実行して、TektonConfig CR を編集します。

   $ oc edit TektonConfig config

   Copy to Clipboard Toggle word wrap
2. TektonConfig CR で、createRbacResource パラメーターの値を false に設定します。

手順

1. TektonConfig CR で、spec.pruner.disabled フィールドを true に設定してデフォルトのプルーナーを無効にし、spec.tektonpruner.disabled フィールドを false に設定してイベントベースのプルーナーを有効にします。以下に例を示します。

   apiVersion: operator.tekton.dev/v1alpha1
   kind: TektonConfig
   metadata:
    name: config
   spec:
     # ...
     pruner:
       disabled: true
     # ...
     tektonpruner:
       disabled: false
       options: {}
     # ...

   Copy to Clipboard Toggle word wrap

   更新された CR を適用すると、Operator は tekton-pruner-controller Pod を openshift-pipelines namespace にデプロイします。

2. openshift-pipelines namespace に次の config map が存在することを確認します。

   Expand

   config map	目的
   tekton-pruner-default-spec	デフォルトのプルーニング動作を定義する
   pruner-info	コントローラーが使用する内部ランタイムデータを保存する
   config-logging-tekton-pruner	プルーナーのロギング設定を行う
   config-observability-tekton-pruner	メトリクスやトレーシングなどの可観測性機能を有効にする

   Show more

検証

1. tekton-pruner-controller Pod が実行中であることを確認するには、次のコマンドを実行します。

   $ oc get pods -n openshift-pipelines

   Copy to Clipboard Toggle word wrap

2. 出力に Running 状態の tekton-pruner-controller Pod が含まれていることを確認します。出力例:

   $ tekton-pruner-controller-<id>       Running

   Copy to Clipboard Toggle word wrap

手順

1. OpenShift パイプラインコントローラーが作成した Webhook の一覧を表示します。Webhook には、変更用 Webhook と検証 Webhook の 2 つのタイプがあります。

   1. 変更用の Webhook のリストを表示するには、以下のコマンドを入力します。

      $ oc get MutatingWebhookConfiguration

      Copy to Clipboard Toggle word wrap

      出力例

      NAME                             WEBHOOKS   AGE
      annotation.operator.tekton.dev   1          4m20s
      proxy.operator.tekton.dev        1          4m20s
      webhook.operator.tekton.dev      1          4m22s
      webhook.pipeline.tekton.dev      1          4m20s
      webhook.triggers.tekton.dev      1          3m50s

      Copy to Clipboard Toggle word wrap

   2. 検証用 Webhook の一覧を表示するには、以下のコマンドを入力します。

      $ oc get ValidatingWebhookConfiguration

      Copy to Clipboard Toggle word wrap

      出力例

      NAME                                                 WEBHOOKS   AGE
      config.webhook.operator.tekton.dev                   1          4m24s
      config.webhook.pipeline.tekton.dev                   1          4m22s
      config.webhook.triggers.tekton.dev                   1          3m52s
      namespace.operator.tekton.dev                        1          4m22s
      validation.pipelinesascode.tekton.dev                1          2m49s
      validation.webhook.operator.tekton.dev               1          4m24s
      validation.webhook.pipeline.tekton.dev               1          4m22s
      validation.webhook.triggers.tekton.dev               1          3m52s

      Copy to Clipboard Toggle word wrap

2. TektonConfig カスタムリソース (CR) で、次の例に示すように、必要に応じて各コントローラーのセクションの下に、Webhook を変更および検証するための設定を追加します。検証用の Webhook には validation.webhook.pipeline.tekton.dev 仕様、変更用の Webhook には webhook.pipeline.tekton.dev 仕様を使用します。

   重要
   • operator Webhook の設定を指定できません。
   • すべての設定はオプションです。たとえば、timeoutSeconds パラメーターを設定し、failurePolicy および sideEffects パラメーターを省略できます。

   Pipelines コントローラーの設定例

   apiVersion: operator.tekton.dev/v1
   kind: TektonConfig
   metadata:
     name: config
   spec:
     pipeline:
       options:
         webhookConfigurationOptions:
           validation.webhook.pipeline.tekton.dev:
             failurePolicy: Fail
             timeoutSeconds: 20
             sideEffects: None
           webhook.pipeline.tekton.dev:
             failurePolicy: Fail
             timeoutSeconds: 20
             sideEffects: None

   Copy to Clipboard Toggle word wrap

   トリガーコントローラーの設定例

   apiVersion: operator.tekton.dev/v1
   kind: TektonConfig
   metadata:
     name: config
   spec:
     triggers:
       options:
         webhookConfigurationOptions:
           validation.webhook.triggers.tekton.dev:
             failurePolicy: Fail
             timeoutSeconds: 20
             sideEffects: None
           webhook.triggers.tekton.dev:
             failurePolicy: Fail
             timeoutSeconds: 20
             sideEffects: None

   Copy to Clipboard Toggle word wrap

   Pipelines as Code コントローラーの設定例

   apiVersion: operator.tekton.dev/v1
   kind: TektonConfig
   metadata:
     name: config
   spec:
     pipelinesAsCode:
       options:
         webhookConfigurationOptions:
           validation.pipelinesascode.tekton.dev:
             failurePolicy: Fail
             timeoutSeconds: 20
             sideEffects: None
           pipelines.triggers.tekton.dev:
             failurePolicy: Fail
             timeoutSeconds: 20
             sideEffects: None

   Copy to Clipboard Toggle word wrap

   Tekton Hub コントローラーの設定例

   apiVersion: operator.tekton.dev/v1
   kind: TektonConfig
   metadata:
     name: config
   spec:
     hub:
       options:
         webhookConfigurationOptions:
           validation.webhook.hub.tekton.dev:
             failurePolicy: Fail
             timeoutSeconds: 20
             sideEffects: None
           webhook.hub.tekton.dev:
             failurePolicy: Fail
             timeoutSeconds: 20
             sideEffects: None

   Copy to Clipboard Toggle word wrap