Pipeline

手順

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

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

   注記

   OpenShift Pipelines Operator の コミュニティー バージョンを選択しないようにしてください。

3. OpenShift Pipelines Operator ページで Operator についての簡単な説明を参照してください。Install をクリックします。

4. Create Operator Subscription ページで以下を実行します。

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

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

   注記

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

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

手順

1. Subscription オブジェクトの YAML ファイルを作成し、namespace を 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

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

手順

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

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

   注記

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

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

手順

1. Operators → OperatorHub ページから、Filter by keyword ボックスを使用して 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 を表示します。

   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-1/01_pipeline/01_apply_manifest_task.yaml
   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-1/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
   buildah-v0-11-3                          1 day ago
   git-clone                                1 day ago
   jib-maven                                1 day ago
   kn                                       1 day ago
   maven                                    1 day ago
   openshift-client                         1 day ago
   openshift-client-v0-11-3                 1 day ago
   s2i                                      1 day ago
   s2i-dotnet-3                             1 day ago
   s2i-dotnet-3-v0-11-3                     1 day ago
   s2i-go                                   1 day ago
   s2i-go-v0-11-3                           1 day ago
   s2i-java-11                              1 day ago
   s2i-java-11-v0-11-3                      1 day ago
   s2i-java-8                               1 day ago
   s2i-java-8-v0-11-3                       1 day ago
   s2i-nodejs                               1 day ago
   s2i-nodejs-v0-11-3                       1 day ago
   s2i-perl                                 1 day ago
   s2i-perl-v0-11-3                         1 day ago
   s2i-php                                  1 day ago
   s2i-php-v0-11-3                          1 day ago
   s2i-python-3                             1 day ago
   s2i-python-3-v0-11-3                     1 day ago
   s2i-ruby                                 1 day ago
   s2i-ruby-v0-11-3                         1 day ago
   s2i-v0-11-3                              1 day ago
   tkn                                      1 day ago

手順

1. フロントエンドアプリケーションの Git リポジトリーを定義する PipelineResource を作成します。

   $ tkn resource create
   ? Enter a name for a pipeline resource : ui-repo
   ? Select a resource type to create : git
   ? Enter a value for url : http://github.com/openshift-pipelines/vote-ui.git
   ? Enter a value for revision : release-tech-preview-1

   この出力では、ui-repo PipelineResource が作成されていることを検証します。

   New git resource "ui-repo" has been created

2. フロントエンドイメージのプッシュ先に対して OpenShift Container Platform 内部イメージレジストリーを定義する PipelineResource を作成します。

   $ tkn resource create
   ? Enter a name for a pipeline resource : ui-image
   ? Select a resource type to create : image
   ? Enter a value for url : image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/ui:latest
   ? Enter a value for digest :

   この出力では、ui-image PipelineResource が作成されていることを検証します。

   New image resource "ui-image" has been created

3. バックエンドアプリケーションの Git リポジトリーを定義する PipelineResource を作成します。

   $ tkn resource create
   ? Enter a name for a pipeline resource : api-repo
   ? Select a resource type to create : git
   ? Enter a value for url : http://github.com/openshift-pipelines/vote-api.git
   ? Enter a value for revision : release-tech-preview-1

   出力では、api-repo PipelineResource が作成されていることを検証します。

   New git resource "api-repo" has been created

4. バックエンドイメージのプッシュ先に対して OpenShift Container Platform 内部イメージレジストリーを定義する PipelineResource を作成します。

   $ tkn resource create
   ? Enter a name for a pipeline resource : api-image
   ? Select a resource type to create : image
   ? Enter a value for url : image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/api:latest
   ? Enter a value for digest :

   この出力では、api-image PipelineResource が作成されていることを検証します。

   New image resource "api-image" has been created

5. 作成された resources の一覧を表示します。

   $ tkn resource list

   出力には、作成されているすべての PipelineResource が一覧表示されます。

   NAME        TYPE    DETAILS
   api-repo    git     url: http://github.com/openshift-pipelines/vote-api.git
   ui-repo     git     url: http://github.com/openshift-pipelines/vote-ui.git
   api-image   image   url: image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/api:latest
   ui-image    image   url: image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/ui:latest

手順

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

   apiVersion: tekton.dev/v1beta1
   kind: Pipeline
   metadata:
     name: build-and-deploy
   spec:
     resources:
     - name: git-repo
       type: git
     - name: image
       type: image
     params:
     - name: deployment-name
       type: string
       description: name of the deployment to be patched
     tasks:
     - name: build-image
       taskRef:
         name: buildah
         kind: ClusterTask
       resources:
         inputs:
         - name: source
           resource: git-repo
         outputs:
         - name: image
           resource: image
       params:
       - name: TLSVERIFY
         value: "false"
     - name: apply-manifests
       taskRef:
         name: apply-manifests
       resources:
         inputs:
         - name: source
           resource: git-repo
       runAfter:
       - build-image
     - name: update-deployment
       taskRef:
         name: update-deployment
       resources:
         inputs:
         - name: image
           resource: image
       params:
       - name: deployment
         value: $(params.deployment-name)
       runAfter:
       - apply-manifests

   Pipeline 定義は、Pipeline の実行時に使用される Git ソースリポジトリーおよびイメージレジストリーの詳細を抽象化します。

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-1/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. バックエンドアプリケーションの Pipeline を起動します。

   $ tkn pipeline start build-and-deploy -r git-repo=api-repo -r image=api-image -p deployment-name=vote-api

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

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

   $ tkn pipelinerun logs <pipelinerun ID> -f

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

   $ tkn pipeline start build-and-deploy -r git-repo=ui-repo -r image=ui-image -p deployment-name=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-1/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: master
     - name: git-repo-name
       description: The name of the deployment to be created / patched
   
     resourcetemplates:
     - apiVersion: tekton.dev/v1alpha1
       kind: PipelineResource
       metadata:
         name: $(params.git-repo-name)-git-repo-$(uid)
       spec:
         type: git
         params:
         - name: revision
           value: $(params.git-revision)
         - name: url
           value: $(params.git-repo-url)
   
     - apiVersion: tekton.dev/v1alpha1
       kind: PipelineResource
       metadata:
         name: $(params.git-repo-name)-image-$(uid)
       spec:
         type: image
         params:
         - name: url
           value: image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/$(params.git-repo-name):latest
   
     - apiVersion: tekton.dev/v1beta1
       kind: PipelineRun
       metadata:
         name: build-deploy-$(params.git-repo-name)-$(uid)
       spec:
         serviceAccountName: pipeline
         pipelineRef:
           name: build-and-deploy
         resources:
         - name: git-repo
           resourceRef:
             name: $(params.git-repo-name)-git-repo-$(uid)
         - name: image
           resourceRef:
             name: $(params.git-repo-name)-image-$(uid)
         params:
         - name: deployment-name
           value: $(params.git-repo-name)

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-1/03_triggers/02_template.yaml

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

   apiVersion: triggers.tekton.dev/v1alpha1
   kind: EventListener
   metadata:
     name: vote-app
   spec:
     serviceAccountName: pipeline
     triggers:
     - bindings:
       - name: 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-1/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-api のクローンを作成します。

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

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

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

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

   $ tkn pipelinerun list

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

手順

1. Developer パースペクティブの Pipelines ビューで、Project ドロップダウンリストからプロジェクトを選択し、そのプロジェクトの Pipeline を表示します。
2. 必要な Pipeline をクリックし、Pipeline Details ページを表示します。これにより、Pipeline のすべての直列および並列の Task が視覚的に表示されます。Task はページの右下にも一覧表示されます。一覧表示されている Task をクリックし、Task の詳細を表示できます。

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

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