手順

1. Web コンソールの Administrator パースペクティブで、Operators → OperatorHub に移動します。

2. Filter by keyword ボックスを使用して、カタログで Red Hat OpenShift Pipelines Operator を検索します。OpenShift Pipelines Operator タイルをクリックします。

   注記

   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 を選択します。

      • ocp-<4.x> チャネルは、 Red Hat OpenShift Pipelines Operator の最新の安定したリリースのインストールを可能にします。
      • preview チャネルは、Red Hat OpenShift Pipelines Operator の最新プレビューバージョンのインストールを有効にします。これには、4.x 更新チャネルでは利用できない機能が含まれる場合があります。

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

   注記

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

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

手順

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

   Subscription の例

   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

   1

   Operator のサブスクライブ元のチャネル名を指定します。

   2

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

   3

   Operator を提供する CatalogSource の名前。

   4

   CatalogSource の namespace。デフォルトの OperatorHub CatalogSource には openshift-marketplace を使用します。

2. Subscription オブジェクトを作成します。

   $ oc apply -f sub.yaml

   Red Hat OpenShift Pipelines Operator がデフォルトのターゲット namespace openshift-operators にインストールされるようになりました。

手順

1. Web コンソールの Administrator パースペクティブで、Administration → Custom Resource Definition に移動します。
2. Filter by name ボックスに config.operator.tekton.dev を入力し、 Red Hat OpenShift Pipelines Operator CR を検索します。
3. CRD Config をクリックし、 Custom Resource Definition Details ページを表示します。

4. Actions ドロップダウンメニューをクリックし、Delete Custom Resource Definition を選択します。

   注記

   CR を削除すると Red Hat OpenShift Pipelines コンポーネントが削除され、クラスター上のすべての Task および Pipeline が失われます。

5. Delete をクリックし、CR の削除を確認します。

手順

1. Operators → OperatorHub ページから、Filter by keyword ボックスを使用して Red Hat OpenShift Pipelines Operator を検索します。
2. OpenShift Pipelines Operator タイルをクリックします。Operator タイルはこれがインストールされていることを示します。
3. OpenShift Pipelines Operator 記述子ページで、Uninstall をクリックします。

手順

1. OpenShift Container Platform クラスターにログインします。

   $ oc login -u <login> -p <password> https://openshift.example.com:6443

2. サンプルアプリケーションのプロジェクトを作成します。このサンプルワークフローでは、pipelines-tutorial プロジェクトを作成します。

   $ oc new-project pipelines-tutorial

   注記

   別の名前でプロジェクトを作成する場合は、サンプルで使用されているリソース URL をプロジェクト名で更新してください。

3. pipeline ServiceAccount を表示します。

   Red Hat OpenShift Pipelines Operator は、イメージのビルドおよびプッシュを実行するのに十分なパーミッションを持つ pipeline という名前の ServiceAccount を追加し、設定します。この ServiceAccount は PipelineRun によって使用されます。

   $ oc get serviceaccount pipeline

手順

1. pipelines-tutorial リポジトリーから apply-manifests および update-deployment Task をインストールします。これには、Pipeline の再利用可能な Task の一覧が含まれます。

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-2/01_pipeline/01_apply_manifest_task.yaml
   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-2/01_pipeline/02_update_deployment_task.yaml

2. tkn task list コマンドを使用して、作成した Task を一覧表示します。

   $ tkn task list

   出力では、apply-manifests および update-deployment Task が作成されていることを検証します。

   NAME                DESCRIPTION   AGE
   apply-manifests                   1 minute ago
   update-deployment                 48 seconds ago

3. tkn clustertasks list コマンドを使用して、--buildah および s2i-python-3 などの Operator でインストールされた追加の ClusterTask を一覧表示します。

   注記

   特権付きセキュリティーコンテキストが必要になるため、特権付き Pod コンテナーを使用して buildah ClusterTask を実行する必要があります。Pod の SCC (Security Context Constraints) についての詳細は、追加リソースセクションを参照してください。

   $ tkn clustertasks list

   出力には、Operator でインストールされた ClusterTask が一覧表示されます。

   NAME                       DESCRIPTION   AGE
   buildah                                  1 day ago
   git-clone                                1 day ago
   s2i-php                                  1 day ago
   tkn                                      1 day ago

手順

1. 以下のサンプルの Pipeline YAML ファイルの内容をコピーし、保存します。

   apiVersion: tekton.dev/v1beta1
   kind: Pipeline
   metadata:
     name: build-and-deploy
   spec:
     workspaces:
     - name: shared-workspace
     params:
     - name: deployment-name
       type: string
       description: name of the deployment to be patched
     - name: git-url
       type: string
       description: url of the git repo for the code of deployment
     - name: git-revision
       type: string
       description: revision to be used from repo of the code for deployment
       default: "release-tech-preview-2"
     - name: IMAGE
       type: string
       description: image to be built from the code
     tasks:
     - name: fetch-repository
       taskRef:
         name: git-clone
         kind: ClusterTask
       workspaces:
       - name: output
         workspace: shared-workspace
       params:
       - name: url
         value: $(params.git-url)
       - name: subdirectory
         value: ""
       - name: deleteExisting
         value: "true"
       - name: revision
         value: $(params.git-revision)
     - name: build-image
       taskRef:
         name: buildah
         kind: ClusterTask
       params:
       - name: TLSVERIFY
         value: "false"
       - name: IMAGE
         value: $(params.IMAGE)
       workspaces:
       - name: source
         workspace: shared-workspace
       runAfter:
       - fetch-repository
     - name: apply-manifests
       taskRef:
         name: apply-manifests
       workspaces:
       - name: source
         workspace: shared-workspace
       runAfter:
       - build-image
     - name: update-deployment
       taskRef:
         name: update-deployment
       workspaces:
       - name: source
         workspace: shared-workspace
       params:
       - name: deployment
         value: $(params.deployment-name)
       - name: IMAGE
         value: $(params.IMAGE)
       runAfter:
       - apply-manifests

   Pipeline 定義は、Git ソースリポジトリーおよびイメージレジストリーの詳細を抽象化します。これらの詳細は、Pipeline のトリガーおよび実行時に params として追加されます。

2. Pipeline を作成します。

   $ oc create -f <pipeline-yaml-file-name.yaml>

   または、Git リポジトリーから YAML ファイルを直接実行することもできます。

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-2/01_pipeline/04_pipeline.yaml

3. tkn pipeline list コマンドを使用して、Pipeline がアプリケーションに追加されていることを確認します。

   $ tkn pipeline list

   この出力では、build-and-deploy Pipeline が作成されていることを検証します。

   NAME               AGE            LAST RUN   STARTED   DURATION   STATUS
   build-and-deploy   1 minute ago   ---        ---       ---        ---

手順

1. 以下の PersistentVolumeClaim YAML ファイルのサンプルをコピーし、保存します。

   apiVersion: v1
   kind: PersistentVolumeClaim
   metadata:
     name: source-pvc
   spec:
     accessModes:
       - ReadWriteOnce
     resources:
       requests:
         storage: 500Mi

2. 作成したファイルを指定して PersistentVolumeClaim を作成します。

   $ oc create -f <PersistentVolumeClaim-yaml-file-name.yaml>

   または、Git リポジトリーから YAML ファイルを直接実行することができます。

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-2/01_pipeline/03_persistent_volume_claim.yaml

手順

1. バックエンドアプリケーションの Pipeline を起動します。

   $ tkn pipeline start build-and-deploy -w name=shared-workspace,claimName=source-pvc -p deployment-name=vote-api -p git-url=http://github.com/openshift-pipelines/vote-api.git -p IMAGE=image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/vote-api

   コマンド出力で返される PipelineRun ID をメモします。

2. PipelineRun の進捗を追跡します。

   $ tkn pipelinerun logs <pipelinerun ID> -f

3. フロントエンドアプリケーションの Pipeline を起動します。

   $ tkn pipeline start build-and-deploy -w name=shared-workspace,claimName=source-pvc -p deployment-name=vote-api -p git-url=http://github.com/openshift-pipelines/vote-ui.git -p IMAGE=image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/vote-ui

   コマンド出力で返される PipelineRun ID をメモします。

4. PipelineRun の進捗を追跡します。

   $ tkn pipelinerun logs <pipelinerun ID> -f

5. 数分後に、tkn pipelinerun list コマンドを使用して、すべての PipelineRun を一覧表示して Pipeline が正常に実行されたことを確認します。

   $ tkn pipelinerun list

   出力には、PipelineRun が一覧表示されます。

    NAME                         STARTED      DURATION     STATUS
    build-and-deploy-run-xy7rw   1 hour ago   2 minutes    Succeeded
    build-and-deploy-run-z2rz8   1 hour ago   19 minutes   Succeeded

6. アプリケーションルートを取得します。

   $ oc get route vote-ui --template='http://{{.spec.host}}'

   上記のコマンドの出力に留意してください。このルートを使用してアプリケーションにアクセスできます。

7. 直前の Pipeline の PipelineResource および ServiceAccount を使用して最後の PipelineRun を再実行するには、以下を実行します。

   $ tkn pipeline start build-and-deploy --last

手順

1. 以下のサンプル TriggerBinding YAML ファイルの内容をコピーし、これを保存します。

   apiVersion: triggers.tekton.dev/v1alpha1
   kind: TriggerBinding
   metadata:
     name: vote-app
   spec:
     params:
     - name: git-repo-url
       value: $(body.repository.url)
     - name: git-repo-name
       value: $(body.repository.name)
     - name: git-revision
       value: $(body.head_commit.id)

2. TriggerBinding を作成します。

   $ oc create -f <triggerbinding-yaml-file-name.yaml>

   または、TriggerBinding を pipelines-tutorial Git リポジトリーから直接作成できます。

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-2/03_triggers/01_binding.yaml

3. 以下のサンプル TriggerTemplate YAML ファイルの内容をコピーし、これを保存します。

   apiVersion: triggers.tekton.dev/v1alpha1
   kind: TriggerTemplate
   metadata:
     name: vote-app
   spec:
     params:
     - name: git-repo-url
       description: The git repository url
     - name: git-revision
       description: The git revision
       default: release-tech-preview-2
     - name: git-repo-name
       description: The name of the deployment to be created / patched
   
     resourcetemplates:
     - apiVersion: tekton.dev/v1beta1
       kind: PipelineRun
       metadata:
         name: build-deploy-$(params.git-repo-name)-$(uid)
       spec:
         serviceAccountName: pipeline
         pipelineRef:
           name: build-and-deploy
         params:
         - name: deployment-name
           value: $(tt.params.git-repo-name)
         - name: git-url
           value: $(tt.params.git-repo-url)
         - name: git-revision
           value: $(tt.params.git-revision)
         - name: IMAGE
           value: image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/$(tt.params.git-repo-name)
         workspaces:
         - name: shared-workspace
           persistentvolumeclaim:
             claimName: source-pvc

4. TriggerTemplate を作成します。

   $ oc create -f <triggertemplate-yaml-file-name.yaml>

   または、TriggerTemplate を pipelines-tutorial Git リポジトリーから直接作成できます。

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-2/03_triggers/02_template.yaml

5. 以下のサンプル EventListener YAML ファイルの内容をコピーし、これを保存します。

   apiVersion: triggers.tekton.dev/v1alpha1
   kind: EventListener
   metadata:
     name: vote-app
   spec:
     serviceAccountName: pipeline
     triggers:
     - bindings:
       - ref: vote-app
       template:
         name: vote-app

6. EventListener を作成します。

   $ oc create -f <eventlistener-yaml-file-name.yaml>

   または、EvenListener を pipelines-tutorial Git リポジトリーから直接作成できます。

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-2/03_triggers/03_event_listener.yaml

7. EventListener サービスを OpenShift Container Platform ルートとして公開し、これをアクセス可能にします。

   $ oc expose svc el-vote-app

手順

1. Webhook URL を取得します。

   $ echo "URL: $(oc  get route el-vote-app --template='http://{{.spec.host}}')"

   出力で取得した URL をメモします。

2. フロントエンドリポジトリーで Webhook を手動で設定します。

   1. フロントエンド Git リポジトリー vote-ui をブラウザーで開きます。
   2. Settings → Webhooks → Add Webhook をクリックします。

   3. Webhooks/Add Webhook ページで以下を実行します。

      1. 手順 1 の Webhook URL を Payload URL フィールドに入力します。
      2. Content type について application/json を選択します。
      3. シークレットを Secret フィールドに指定します。
      4. Just the push event が選択されていることを確認します。
      5. Active を選択します。
      6. Add Webhook をクリックします。
3. バックエンドリポジトリー vote-api について手順 2 を繰り返します。

手順

1. ターミナルから、フォークした Git リポジトリー vote-ui のクローンを作成します。

   $ git clone git@github.com:<your GitHub ID>/vote-ui.git -b release-tech-preview-2

2. 空のコミットをプッシュします。

   $ git commit -m "empty-commit" --allow-empty && git push origin release-tech-preview-2

3. PipelineRun がトリガーされたかどうかを確認します。

   $ tkn pipelinerun list

   新規の PipelineRun が開始されたことに注意してください。

手順

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

3. Select task 一覧から Task を選択し、Task を Pipeline に追加します。この例では、s2i-nodejs Task を使用します。

   1. 連続する Task を Pipeline に追加するには、Task の右側または左側にあるプラスアイコンをクリックし、Select task 一覧から、Pipeline に追加する必要のある Task を選択します。この例では、s2i-nodejs Task の右側にあるプラスアイコンを使用して、openshift-client Task を追加します。

   2. 並列の Task を既存の Task に追加するには、Task の下に表示されるプラスアイコンをクリックし、Select Task 一覧から Pipeline に追加する必要のある並列 Task を選択します。

      図5.1 Pipeline Builder

      

4. Add Resources をクリックし、Pipeline Run が使用するリソースの名前およびタイプを指定します。これらのリソースは、Pipeline の Task によって入力および出力として使用されます。この例では、以下のようになります。

   1. 入力リソースを追加します。Name フィールドに Source を入力し、Resource Type ドロップダウンリストから Git を選択します。
   2. 出力リソースを追加します。Name フィールドに Img を入力し、Resource Type ドロップダウンリストから イメージ を選択します。
5. Task の パラメーター は、Task の仕様に基づいて事前に設定されます。必要な場合は、Add Parameters リンクを使用してパラメーターを追加します。

6. Task のリソースが指定されていない場合、Missing Resources (リソース不足) の警告が Task に表示されます。s2i-nodejs Task をクリックし、Task の詳細情報が含まれるサイドパネルを表示します。

   図5.2 Pipelines Builder の Task の詳細

   

7. Task サイドパネルで、そのリソースおよびパラメーターを指定します。

   1. Input Resources → Source セクションで、Select Resources ドロップダウンリストに、Pipeline に追加したリソースが表示されます。この例では、Source を選択します。
   2. Output Resources → Image セクションで Select Resources リストをクリックし、Img を選択します。
   3. 必要な場合は、$(params.<param-name>) 構文を使用して、Parameters セクションでデフォルトのパラメーターに他のパラメーターを追加します。
8. 同様に、openshift-client Task の入力リソースを追加します。
9. Create をクリックして Pipeline を作成します。作成された Pipeline の詳細を表示する Pipeline Details ページにリダイレクトされます。Action ボタンを使用して Pipeline を開始できるようになりました。

手順

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

   図5.3 Developer パースペクティブの Pipeline ビュー

   
2. 必要な Pipeline をクリックし、Pipeline Details ページを表示します。このページには、Pipeline のすべての直列および並列 Task が視覚的に表示されます。Task はページの右下にも一覧表示されます。一覧表示されている Task をクリックし、Task の詳細を表示できます。

3. オプションで、Pipeline Details ページで以下を実行します。

   • YAML タブをクリックし、Pipeline の YAML ファイルを編集します。
   • Pipeline Runs タブをクリックして、Pipeline の完了済み、実行中、または失敗した実行を確認します。Options メニュー を使用して、実行中の Pipeline を停止するか、以前の Pipeline 実行と同じパラメーターとリソースを使用して Pipeline を再実行するか、または PipelineRun を削除します。
   • Parameters タブをクリックして、Pipeline に定義されるパラメーターを表示します。必要に応じて追加のパラメーターを追加するか、または編集することもできます。
   • Resources タブをクリックして、Pipeline で定義されたリソースを表示します。必要に応じて追加のリソースを追加するか、または編集することもできます。

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

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

   注記

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

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

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

   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 Crendentials については、認証する 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 フィールドの値を指定します。
      4. シークレットを追加するためにチェックマークを選択します。

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

4. Start をクリックして PipelineRun を開始します。

5. Pipeline Run Details ページには、実行される Pipeline が表示されます。Pipeline が開始すると、各 Task 内の Task および Step が実行されます。以下を実行することができます。

   • 各 Step の実行にかかった時間を表示するには、Task にカーソルを合わせます。
   • Task をクリックし、Task の各 Step のログを表示します。

   • Logs タブをクリックして、Task の実行シーケンスに基づいてログを表示し、Download ボタンを使用してログをテキストファイルにダウンロードします。

     図5.4 Pipeline Run

     

6. From Git オプションを使用して作成される Pipeline の場合、Topology ビューを使用して、開始後の Pipeline と対話することができます。

   注記

   Topology ビューで Pipeline Builder を使用して作成される Pipeline を表示するには、Pipeline ラベルをカスタマイズし、Pipeline をアプリケーションのワークロードにリンクします。

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

   2. Pipeline Runs セクションで、Start Last Run をクリックし、直前のパラメーターおよびリソースと同じパラメーターおよびリソースを使用して新規 Pipeline Run を開始します。このオプションは、Pipeline Run が開始されていない場合は無効になります。

      図5.5 Topology ビューの Pipeline

      
   3. Topology ページで、アプリケーションの左側にカーソルを合わせ、アプリケーションの Pipeline Run のステータスを確認します。

手順

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

2. Pipeline Builder ページで以下を行います。

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

手順

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