3.9. 開発者パースペクティブを使用した Red Hat OpenShift Pipelines の使用

手順

1. Developer パースペクティブの +Add ビューで、Pipeline タイルをクリックし、Pipeline Builder ページを表示します。

2. Pipeline ビルダー ビューまたは YAML ビュー のいずれかを使用して、パイプラインを設定します。

   注記

   Pipeline ビルダー ビューは、限られた数のフィールドをサポートしますが、YAML ビュー は利用可能なすべてのフィールドをサポートします。オプションで、Operator によってインストールされた、再利用可能なスニペットおよびサンプルを使用して、詳細な Pipeline を作成することもできます。

   図3.1 YAML ビュー

   

3. Pipeline builder を使用してパイプラインを設定します。

   1. Name フィールドにパイプラインの一意の名前を入力します。

   2. Tasks セクションで、以下を実行します。

      1. Add task をクリックします。
      2. クイック検索フィールドを使用してタスクを検索し、表示された一覧から必要なタスクを選択します。

      3. Add または Install and add をクリックします。この例では、s2i-nodejs タスクを使用します。

         注記

         検索の一覧には、Tekton Hub タスクおよび、クラスターで利用可能なタスクがすべて含まれます。また、タスクがすでにインストールされている場合は、タスク追加用の Add が表示され、それ以外の場合は、タスクのインストールおよび追加用の Install and add が表示されます。更新されたバージョンで同じタスクを追加する場合は、Update and add が表示されます。

         • 連続するタスクをパイプラインに追加するには、以下を実行します。

           • タスクの右側にあるプラスアイコンをクリックし、Add task をクリックします。
           • クイック検索フィールドを使用してタスクを検索し、表示された一覧から必要なタスクを選択します。

           • Add または Install and add をクリックします。

             図3.2 Pipeline Builder

             

         • 最終タスクを追加するには、以下を実行します。

           • Add finally task → Add task の順にクリックします。
           • クイック検索フィールドを使用してタスクを検索し、表示された一覧から必要なタスクを選択します。
           • Add または Install and add をクリックします。

   3. Resources セクションで、Add Resources をクリックし、パイプライン実行用のリソースの名前およびタイプを指定します。これらのリソースは、パイプラインのタスクによって入力および出力として使用されます。この例では、以下のようになります。

      1. 入力リソースを追加します。Name フィールドに Source を入力してから、Resource Type ドロップダウンリストから Git を選択します。

      2. 出力リソースを追加します。Name フィールドに Img を入力してから、Resource Type ドロップダウンリストから イメージ を選択します。

         注記

         リソースが見つからない場合には、タスクの横に赤のアイコンが表示されます。

   4. オプション: タスクの Parameters は、タスクの仕様に基づいて事前に設定されます。必要な場合は、Parameters セクションの Add Parameters リンクを使用して、パラメーターを追加します。
   5. Workspaces セクションで、Add workspace をクリックし、Name フィールドに一意のワークスペース名を入力します。複数のワークスペースをパイプラインに追加できます。

   6. Tasks セクションで、s2i-nodejs タスクをクリックし、タスクの詳細情報が含まれるサイドパネルを表示します。タスクのサイドパネルで、s2i-nodejs タスクのリソースおよびパラメーターを指定します。

      1. 必要な場合は、Parameters セクションで、$(params.<param-name>) 構文を使用して、デフォルトのパラメーターにパラメーターをさらに追加します。
      2. Image セクションで、Resources セクションで指定されているように Img を入力します。
      3. Workspace セクションの source ドロップダウンからワークスペースを選択します。
   7. リソース、パラメーター、およびワークスペースを openshift-client タスクに追加します。
4. Create をクリックし、Pipeline Details ページでパイプラインを作成し、表示します。
5. Actions ドロップダウンメニューをクリックしてから Start をクリックし、Start Pipeline ページを表示します。
6. Workspace セクションは、以前に作成したワークスペースを一覧表示します。それぞれのドロップダウンを使用して、ワークスペースのボリュームソースを指定します。Empty Directory、Config Map、Secret、PersistentVolumeClaim、または VolumeClaimTemplate のオプションを使用できます。

手順

1. 開発者パースペクティブで、GitHub リポジトリーを追加する namespace またはプロジェクトを選択します。
2. 左側のナビゲーションペインを使用して パイプライン に移動します。
3. Pipelines ページの右側にある Create → Repository をクリックします。
4. Git Repo URL を入力すると、コンソールが自動的にリポジトリー名を取得します。

5. 設定オプションを表示を クリックします。デフォルトでは、Setup a webhook というオプションが 1 つだけ表示されます。GitHub アプリケーションが設定されている場合は、次の 2 つのオプションが表示されます。

   • Use GitHub App: リポジトリーに GitHub アプリケーションをインストールするには、このオプションを選択します。
   • Setup a webhook: Webhook を GitHub アプリケーションに追加するには、このオプションを選択します。

6. Secret セクションで次のいずれかのオプションを使用して Webhook を設定します。

   • Git アクセストークン を使用して Webhook をセットアップします。

     1. 個人用アクセストークンを入力します。

     2. Webhook シークレット フィールドに対応する 生成 をクリックして、新しい Webhook シークレットを生成します。

        
        注記

        個人用アクセストークンを持っておらず、新しいトークンを作成する場合は、Git access token フィールドの下のリンクをクリックできます。

   • Git access token secret を使用して Webhook をセットアップします。

     • ドロップダウンリストから namespace のシークレットを選択します。選択したシークレットに応じて、Webhook シークレットが自動的に生成されます。

       

7. Webhook シークレットの詳細を GitHub リポジトリーに追加します。

   1. Webhook URL をコピーし、GitHub リポジトリー設定に移動します。
   2. Webhooks → Add webhook をクリックします。
   3. 開発者コンソールから Webhook URL をコピーし、GitHub リポジトリー設定の Payload URL フィールドに貼り付けます。
   4. Content type を選択します。
   5. 開発者コンソールから Webhook secret をコピーし、GitHub リポジトリー設定の Secret フィールドに貼り付けます。
   6. SSL 検証 オプションのいずれかを選択します。
   7. この Webhook をトリガーするイベントを選択します。
   8. Add webhook をクリックします。
8. 開発者コンソールに戻り、Add をクリックします。
9. 実行する手順の詳細を確認し、Close をクリックします。
10. 作成したリポジトリーの詳細を表示します。

手順

1. Developer パースペクティブの Pipelines ビューで、Project ドロップダウンリストからプロジェクトを選択し、そのプロジェクトのパイプラインを表示します。

2. 必要なパイプラインをクリックし、Pipeline Details ページを表示します。

   デフォルトでは、Details タブには、すべての serial タスク、parallel タスク、finally タスク、およびパイプライン when の式がすべて視覚的に表示されます。タスクと finally タスクは、ページの右下に一覧表示されます。

   タスクの詳細を表示するには、一覧表示されている Tasks および Finally タスクをクリックします。さらに、以下を実行できます。

   • パイプライン詳細 の視覚化の左下隅に表示される標準アイコンを使用して、ズームイン、ズームアウト、画面サイズの自動調整、およびビューのリセット機能を使用します。
   • マウスホイールを使用して、パイプラインビジュアライゼーションのズーム係数を変更します。

   • タスクにカーソルを合わせ、タスクの詳細を表示します。

     図3.3 Pipeline の詳細

     

3. オプション: Pipeline details ページで、Metrics タブをクリックして、パイプラインに関する以下の情報を表示します。

   • Pipeline 成功比率
   • Pipeline Run の数
   • Pipeline Run の期間

   • Task Run Balancing

     この情報を使用して、パイプラインのワークフローを改善し、パイプラインのライフサイクルの初期段階で問題をなくすことができます。

4. オプション: YAML タブをクリックし、パイプラインの YAML ファイルを編集します。

5. オプション: Pipeline Runs タブをクリックして、パイプラインの完了済み、実行中、または失敗した実行を確認します。

   Pipeline Runs タブでは、パイプライン実行、タスクのステータス、および失敗したパイプライン実行のデバッグ用のリンクの詳細が表示されます。Options メニュー を使用して、実行中のパイプラインを停止するか、以前のパイプライン実行と同じパラメーターとリソースを使用してパイプラインを再実行するか、またはパイプライン実行を削除します。

   • 必要なパイプラインをクリックし、Pipeline Run details ページを表示します。デフォルトでは、Details タブには、すべてのシリアルタスク、並列タスク、finally タスク、およびパイプライン実行の式がすべて視覚的に表示されます。実行に成功すると、ページ下部の Pipeline Run results ペインに表示されます。さらに、クラスターでサポートされている Tekton Hub からのタスクのみを表示できます。タスクを見ながら、その横にあるリンクをクリックして、タスクのドキュメントにジャンプできます。

     注記

     Pipeline Run Details ページの Details セクションには、失敗したパイプライン実行の Log Snippet (ログスニペット) が表示されます。Log Snippet (ログスニペット) は、一般的なエラーメッセージとログのスニペットを提供します。Logs セクションへのリンクでは、失敗した実行に関する詳細へのクイックアクセスを提供します。

   • Pipeline Run details ページで、Task Runs タブをクリックして、タスクの完了、実行、および失敗した実行を確認します。

     Task Runs タブは、タスク実行に関する情報と、そのタスクおよび Pod へのリンクと、タスク実行のステータスおよび期間を提供します。Options メニュー を使用してタスク実行を削除します。

   • 必要なタスク実行をクリックして、Task Run details ページを表示します。実行に成功すると、ページ下部の Task Run results ペインに表示されます。

     注記

     Task Run details ページの Details セクションには、失敗したパイプライン実行の Log Snippet (ログスニペット) が表示されます。Log Snippet (ログスニペット) は、一般的なエラーメッセージとログのスニペットを提供します。Logs セクションへのリンクでは、失敗した実行に関する詳細へのクイックアクセスを提供します。

6. Parameters タブをクリックして、パイプラインに定義されるパラメーターを表示します。必要に応じて追加のパラメーターを追加するか、または編集することもできます。
7. Resources タブをクリックして、パイプラインで定義されたリソースを表示します。必要に応じて関連情報を追加するか、または編集することもできます。

手順

1. クラスター管理者として OpenShift Container Platform Web コンソール にログインします。

2. Administrator パースペクティブで、左側のナビゲーションパネルを使用して Pipelines セクションに移動します。

   1. Project ドロップダウンメニューから、openshift プロジェクトを選択します。これにより、後続の手順が openshift namespace で実行されます。

   2. 利用可能なパイプラインの一覧から、アプリケーションのビルドとデプロイに適したパイプラインを選択します。たとえば、アプリケーションに node.js ランタイム環境が必要な場合は、s2i-nodejs パイプラインを選択します。

      注記

      デフォルトのパイプラインテンプレートは編集しないでください。UI とバックエンドとの互換性がなくなる可能性があります。

   3. 選択したパイプラインの YAML タブで、Download をクリックし、YAML ファイルをローカルマシンに保存します。カスタム設定ファイルが失敗した場合は、このコピーを使用して作業設定を復元できます。

3. デフォルトのパイプラインテンプレートを無効化 (削除) します。

   1. 左側のナビゲーションパネルを使用して、Operators → Installed Operators に移動します。
   2. Red Hat OpenShift Pipelines → Tekton Configuration タブ → config → YAML タブをクリックします。

   3. openshift namespace でデフォルトのパイプラインテンプレートを無効化 (削除) するには、pipelineTemplates パラメーターを TektonConfig カスタムリソース YAML で false に設定し、これを保存します。

      apiVersion: operator.tekton.dev/v1alpha1
      kind: TektonConfig
      metadata:
        name: config
      spec:
      profile: all
      targetNamespace: openshift-pipelines
      addon:
        params:
        - name: clusterTasks
          value: "true"
        - name: pipelineTemplates
          value: "false"
      ...

      注記

      デフォルトのパイプラインテンプレートを手動で削除すると、Operator はアップグレード中にデフォルトを復元します。

      警告

      クラスター管理者は、Operator 設定でデフォルトのパイプラインテンプレートのインストールを無効にすることができます。ただし、このような設定では、カスタマイズするパイプラインテンプレートだけでなく、すべての既定のパイプラインテンプレートが削除されます。

4. カスタムパイプラインテンプレートを作成します。

   1. 左側のナビゲーションパネルを使用して、Pipelines セクションに移動します。
   2. Create ドロップダウンメニューから、Pipeline を選択します。

   3. 必要なパイプラインを openshift namespace に作成します。デフォルト名とは別の名前を付けます (例: custom-nodejs)。ダウンロードしたデフォルトのパイプラインテンプレートを開始点として使用し、これをカスタマイズすることができます。

      注記

      openshift は Operator でインストールされるパイプラインテンプレートによって使用されるデフォルトの namespace であるため、openshift namespace にカスタムパイプラインテンプレートを作成する必要があります。アプリケーションがパイプラインテンプレートを使用する場合、テンプレートはそれぞれのプロジェクトの namespace に自動的にコピーされます。

   4. 作成されたパイプラインの Details タブで、カスタムテンプレートの Labels がデフォルトのパイプラインのラベルと一致することを確認します。カスタムパイプラインテンプレートには、アプリケーションのランタイム、タイプ、ストラテジーの正しいラベルが必要です。たとえば、OpenShift Container Platform にデプロイされる node.js アプリケーションの必須ラベルは以下のようになります。

      ...
      pipeline.openshift.io/runtime: nodejs
      pipeline.openshift.io/type: openshift
      ...

      注記

      ランタイムの環境とデプロイメントタイプの組み合わせごとに 1 つのパイプラインテンプレートのみを使用できます。

5. Developer パースペクティブで、+Add → Git Repository → From Git オプションを使用して、作成およびデプロイするアプリケーションの種類を選択します。必要なランタイムとアプリケーションのタイプに基づいて、カスタムテンプレートが自動的に選択されます。

1. Developer パースペクティブの Pipelines ビューで、パイプラインに隣接する Options メニューで、Start を選択します。

2. Start Pipeline ダイアログボックスは、パイプライン定義に基づいて Git Resources および Image Resources を表示します。

   注記

   From Git オプションを使用して作成されるパイプラインの場合、Start Pipeline ダイアログボックスでは Parameters セクションに APP_NAME フィールドも表示され、ダイアログボックスのすべてのフィールドがパイプラインテンプレートによって事前に入力されます。

   1. namespace にリソースがある場合、Git Resources および Image Resources フィールドがそれらのリソースで事前に設定されます。必要な場合は、ドロップダウンを使用して必要なリソースを選択または作成し、Pipeline Run インスタンスをカスタマイズします。

3. オプション: Advanced Options を変更し、認証情報を追加して、指定されたプライベート Git サーバーまたはイメージレジストリーを認証します。

   1. Advanced Options で Show Credentials Options をクリックし、Add Secret を選択します。

   2. Create Source Secret セクションで、以下を指定します。

      1. シークレットの一意の シークレット名。
      2. Designated provider to be authenticated セクションで、Access to フィールドで認証されるプロバイダー、およびベース Server URL を指定します。

      3. Authentication Type を選択し、認証情報を指定します。

         • Authentication Type Image Registry Credentials については、認証する Registry Server Address を指定し、Username、Password、および Email フィールドに認証情報を指定します。

           追加の Registry Server Address を指定する必要がある場合は、Add Credentials を選択します。

         • Authentication Type Basic Authentication については、UserName および Password or Token フィールドの値を指定します。

         • Authentication Type SSH Keys については、SSH Private Key フィールドの値を指定します。

           注記

           Basic 認証および SSH 認証には、以下のようなアノテーションを使用できます。

           • tekton.dev/git-0: https://github.com
           • tekton.dev/git-1: https://gitlab.com.
      4. シークレットを追加するためにチェックマークを選択します。

   パイプラインのリソースの数に基づいて、複数のシークレットを追加できます。

4. Start をクリックしてパイプラインを開始します。

5. PipelineRun details ページには、実行されるパイプラインが表示されます。パイプラインが開始すると、タスクおよび各タスク内のステップが実行されます。以下を行うことができます。

   • PipelineRun 詳細 ページビジュアライゼーションの左下隅にある標準アイコンを使用して、ズームイン、ズームアウト、画面サイズの自動調整、およびビューのリセット機能を使用します。
   • マウスホイールを使用して、パイプライン実行の視覚化のズーム係数を変更します。特定のズーム要素では、タスクの背景色が変更され、エラーまたは警告のステータスが示されます。
   • タスクにカーソルを合わせると、各ステップの実行にかかった時間、タスク名、タスクステータスなどの詳細が表示されます。
   • タスクバッジにカーソルを合わせ、完了したタスクとタスクの合計数を確認します。
   • タスクをクリックし、タスクの各ステップのログを表示します。
   • Logs タブをクリックして、タスクの実行シーケンスに関連するログを表示します。該当するボタンを使用して、ペインを展開し、ログを個別に、または一括してダウンロードすることもできます。

   • Events タブをクリックして、パイプライン実行で生成されるイベントのストリームを表示します。

     Task Runs、Logs、および Events タブを使用すると、失敗したパイプラインの実行またはタスクの実行のデバッグに役立ちます。

     図3.4 パイプライン実行の詳細

     

手順

1. 左側のナビゲーションパネルで Topology をクリックします。
2. アプリケーションをクリックして、サイドパネルに Pipeline Runs を表示します。

3. Pipeline Runs で、Start Last Run をクリックして、前のパイプラインと同じパラメーターとリソースを使用して新しいパイプラインの実行を開始します。このオプションは、パイプライン実行が開始されていない場合は無効になります。パイプラインの作成時にパイプラインの実行を開始することもできます。

   図3.5 Topology ビューのパイプライン

   

手順

1. Developer パースペクティブの Pipelines ビューで、編集する必要のある Pipeline を選択し、Pipeline の詳細を表示します。Pipeline Details ページで Actions をクリックし、Edit Pipeline を選択します。

2. パイプラインビルダー ページでは、次のタスクを実行できます。

   • 追加のタスク、パラメーター、またはリソースをパイプラインに追加します。
   • 変更するタスクをクリックして、サイドパネルにタスクの詳細を表示し、表示名、パラメーター、リソースなどの必要なタスクの詳細を変更します。
   • または、Task を削除するには、Task をクリックし、サイドパネルで Actions をクリックし、Remove Task を選択します。
3. Save をクリックして変更された Pipeline を保存します。

手順

1. Developer パースペクティブの Pipelines ビューで、Pipeline に隣接する Options メニューをクリックし、Delete Pipeline を選択します。
2. Delete Pipeline 確認プロンプトで、Delete をクリックし、削除を確認します。