2.6. カスタムイベントソース

手順

1. シンクバインディングが正しく設定されていることを確認するには、受信メッセージをダンプする Knative イベント表示サービスまたはイベントシンクを作成します。

   1. サービス YAML ファイルを作成します。

      サービス YAML ファイルの例

      apiVersion: serving.knative.dev/v1
      kind: Service
      metadata:
        name: event-display
      spec:
        template:
          spec:
            containers:
              - image: quay.io/openshift-knative/showcase

   2. サービスを作成します。

      $ oc apply -f <filename>

2. イベントをサービスに転送するシンクバインディングインスタンスを作成します。

   1. シンクバインディング YAML ファイルを作成します。

      サービス YAML ファイルの例

      apiVersion: sources.knative.dev/v1alpha1
      kind: SinkBinding
      metadata:
        name: bind-heartbeat
      spec:
        subject:
          apiVersion: batch/v1
          kind: Job 1
          selector:
            matchLabels:
              app: heartbeat-cron
      
        sink:
          ref:
            apiVersion: serving.knative.dev/v1
            kind: Service
            name: event-display

      1

      この例では、ラベル app: heartbeat-cron を指定したジョブがイベントシンクにバインドされます。

   2. シンクバインディングを作成します。

      $ oc apply -f <filename>

3. CronJob オブジェクトを作成します。

   1. cron ジョブの YAML ファイルを作成します。

      cron ジョブの YAML ファイルの例

      apiVersion: batch/v1
      kind: CronJob
      metadata:
        name: heartbeat-cron
      spec:
        # Run every minute
        schedule: "* * * * *"
        jobTemplate:
          metadata:
            labels:
              app: heartbeat-cron
              bindings.knative.dev/include: "true"
          spec:
            template:
              spec:
                restartPolicy: Never
                containers:
                  - name: single-heartbeat
                    image: quay.io/openshift-knative/heartbeats:latest
                    args:
                      - --period=1
                    env:
                      - name: ONE_SHOT
                        value: "true"
                      - name: POD_NAME
                        valueFrom:
                          fieldRef:
                            fieldPath: metadata.name
                      - name: POD_NAMESPACE
                        valueFrom:
                          fieldRef:
                            fieldPath: metadata.namespace

      重要

      シンクバインディングを使用するには、bindings.knative.dev/include=true ラベルを Knative リソースに手動で追加する必要があります。

      たとえば、このラベルを CronJob インスタンスに追加するには、以下の行を Job リソースの YAML 定義に追加します。

        jobTemplate:
          metadata:
            labels:
              app: heartbeat-cron
              bindings.knative.dev/include: "true"

   2. cron ジョブを作成します。

      $ oc apply -f <filename>

4. 以下のコマンドを入力し、出力を検査して、コントローラーが正しくマップされていることを確認します。

   $ oc get sinkbindings.sources.knative.dev bind-heartbeat -oyaml

   出力例

   spec:
     sink:
       ref:
         apiVersion: serving.knative.dev/v1
         kind: Service
         name: event-display
         namespace: default
     subject:
       apiVersion: batch/v1
       kind: Job
       namespace: default
       selector:
         matchLabels:
           app: heartbeat-cron

1. コマンドを入力します。

   $ oc get pods

2. コマンドを入力します。

   $ oc logs $(oc get pod -o name | grep event-display) -c user-container

   出力例

   ☁️  cloudevents.Event
   Validation: valid
   Context Attributes,
     specversion: 1.0
     type: dev.knative.eventing.samples.heartbeat
     source: https://knative.dev/eventing-contrib/cmd/heartbeats/#event-test/mypod
     id: 2b72d7bf-c38f-4a98-a433-608fbcdd2596
     time: 2019-10-18T15:23:20.809775386Z
     contenttype: application/json
   Extensions,
     beats: true
     heart: yes
     the: 42
   Data,
     {
       "id": 1,
       "label": ""
     }

手順

1. シンクバインディングが正しく設定されていることを確認するには、受信メッセージをダンプする Knative イベント表示サービスまたはイベントシンクを作成します。

   $ kn service create event-display --image quay.io/openshift-knative/showcase

2. イベントをサービスに転送するシンクバインディングインスタンスを作成します。

   $ kn source binding create bind-heartbeat --subject Job:batch/v1:app=heartbeat-cron --sink ksvc:event-display

3. CronJob オブジェクトを作成します。

   1. cron ジョブの YAML ファイルを作成します。

      cron ジョブの YAML ファイルの例

      apiVersion: batch/v1
      kind: CronJob
      metadata:
        name: heartbeat-cron
      spec:
        # Run every minute
        schedule: "* * * * *"
        jobTemplate:
          metadata:
            labels:
              app: heartbeat-cron
              bindings.knative.dev/include: "true"
          spec:
            template:
              spec:
                restartPolicy: Never
                containers:
                  - name: single-heartbeat
                    image: quay.io/openshift-knative/heartbeats:latest
                    args:
                      - --period=1
                    env:
                      - name: ONE_SHOT
                        value: "true"
                      - name: POD_NAME
                        valueFrom:
                          fieldRef:
                            fieldPath: metadata.name
                      - name: POD_NAMESPACE
                        valueFrom:
                          fieldRef:
                            fieldPath: metadata.namespace

      重要

      シンクバインディングを使用するには、bindings.knative.dev/include=true ラベルを Knative CR に手動で追加する必要があります。

      たとえば、このラベルを CronJob CR に追加するには、以下の行を Job CR の YAML 定義に追加します。

        jobTemplate:
          metadata:
            labels:
              app: heartbeat-cron
              bindings.knative.dev/include: "true"

   2. cron ジョブを作成します。

      $ oc apply -f <filename>

4. 以下のコマンドを入力し、出力を検査して、コントローラーが正しくマップされていることを確認します。

   $ kn source binding describe bind-heartbeat

   出力例

   Name:         bind-heartbeat
   Namespace:    demo-2
   Annotations:  sources.knative.dev/creator=minikube-user, sources.knative.dev/lastModifier=minikub ...
   Age:          2m
   Subject:
     Resource:   job (batch/v1)
     Selector:
       app:      heartbeat-cron
   Sink:
     Name:       event-display
     Resource:   Service (serving.knative.dev/v1)
   
   Conditions:
     OK TYPE     AGE REASON
     ++ Ready     2m

手順

1. シンクとして使用する Knative サービスを作成します。

   1. Developer パースペクティブで、+Add YAML に移動します。

   2. サンプル YAML をコピーします。

      apiVersion: serving.knative.dev/v1
      kind: Service
      metadata:
        name: event-display
      spec:
        template:
          spec:
            containers:
              - image: quay.io/openshift-knative/showcase

   3. Create をクリックします。

2. イベントソースとして使用される CronJob リソースを作成し、1 分ごとにイベントを送信します。

   1. Developer パースペクティブで、+Add YAML に移動します。

   2. サンプル YAML をコピーします。

      apiVersion: batch/v1
      kind: CronJob
      metadata:
        name: heartbeat-cron
      spec:
        # Run every minute
        schedule: "*/1 * * * *"
        jobTemplate:
          metadata:
            labels:
              app: heartbeat-cron
              bindings.knative.dev/include: true 1
          spec:
            template:
              spec:
                restartPolicy: Never
                containers:
                  - name: single-heartbeat
                    image: quay.io/openshift-knative/heartbeats
                    args:
                    - --period=1
                    env:
                      - name: ONE_SHOT
                        value: "true"
                      - name: POD_NAME
                        valueFrom:
                          fieldRef:
                            fieldPath: metadata.name
                      - name: POD_NAMESPACE
                        valueFrom:
                          fieldRef:
                            fieldPath: metadata.namespace

      1

      bindings.knative.dev/include: true ラベルを含めるようにしてください。OpenShift Serverless のデフォルトの namespace 選択動作は包含モードを使用します。

   3. Create をクリックします。

3. 直前の手順で作成したサービスと同じ namespace、またはイベントの送信先となる他のシンクと同じ namespace にシンクバインディングを作成します。

   1. Developer パースペクティブで、+Add Event Source に移動します。Event Sources ページが表示されます。
   2. オプション: イベントソースに複数のプロバイダーがある場合は、Providers 一覧から必要なプロバイダーを選択し、プロバイダーから利用可能なイベントソースをフィルターします。

   3. Sink Binding を選択し、Create Event Source をクリックします。Create Event Source ページが表示されます。

      注記

      Form view または YAML view を使用して Sink Binding 設定を設定し、ビューを切り替えることができます。ビューの切り替え時に、データは永続化されます。

   4. apiVersion フィールドに batch/v1 を入力します。

   5. Kind フィールドに Job と入力します。

      注記

      CronJob の種類は OpenShift Serverless シンクバインディングで直接サポートされていないため、Kind フィールドは cron ジョブオブジェクト自体ではなく、cron ジョブで作成される Job オブジェクトをターゲットにする必要があります。

   6. Target セクションで、イベントシンクを選択します。これは Resource または URI のいずれかです。

      1. Resource を選択して、チャネル、ブローカー、またはサービスをイベントソースのシンクとして使用します。この例では、前の手順で作成した event-display サービスをターゲット Resource として使用します。
      2. URI を選択して、イベントのルーティング先となる URI (Uniform Resource Identifier) を指定します。

   7. Match labels セクションで以下を実行します。

      1. Name フィールドに app と入力します。

      2. Value フィールドに heartbeat-cron と入力します。

         注記

         ラベルセレクターは、リソース名ではなくシンクバインディングで cron ジョブを使用する場合に必要になります。これは、cron ジョブで作成されたジョブには予測可能な名前がなく、名前に無作為に生成される文字列が含まれているためです。たとえば、hearthbeat-cron-1cc23f になります。

   8. Create をクリックします。

1. Developer パースペクティブで、Topology に移動します。

2. シンクバインディング、シンク、およびハートビートの cron ジョブを表示します。

   
3. シンクバインディングが追加されると、正常なジョブが cron ジョブによって登録されていることを確認します。つまり、シンクバインディングは cron ジョブで作成されたジョブが正常に再設定されることを意味します。

4. イベント表示 サービスを参照して、ハートビート cron ジョブによって生成されたイベントを確認します。

   

手順

1. ServiceMeshMemberRoll のメンバーである namespace に Service を作成します。

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: event-display
     namespace: <namespace> 1
   spec:
     template:
       metadata:
         annotations:
           sidecar.istio.io/inject: "true" 2
           sidecar.istio.io/rewriteAppHTTPProbers: "true"
       spec:
         containers:
         - image: quay.io/openshift-knative/showcase

   1

   ServiceMeshMemberRoll のメンバーである namespace。

   2

   Service Mesh サイドカーは Knative サービス Pod に挿入します。

2. Service リソースを適用します。

   $ oc apply -f <filename>

3. SinkBinding リソースを作成します。

   apiVersion: sources.knative.dev/v1
   kind: SinkBinding
   metadata:
     name: bind-heartbeat
     namespace: <namespace> 1
   spec:
     subject:
       apiVersion: batch/v1
       kind: Job 2
       selector:
         matchLabels:
           app: heartbeat-cron
   
     sink:
       ref:
         apiVersion: serving.knative.dev/v1
         kind: Service
         name: event-display

   1

   ServiceMeshMemberRoll のメンバーである namespace。

   2

   この例では、ラベル app: heartbeat-cron を指定したジョブがイベントシンクにバインドされます。

4. SinkBinding リソースを適用します。

   $ oc apply -f <filename>

5. CronJob を作成します｡

   apiVersion: batch/v1
   kind: CronJob
   metadata:
     name: heartbeat-cron
     namespace: <namespace> 1
   spec:
     # Run every minute
     schedule: "* * * * *"
     jobTemplate:
       metadata:
         labels:
           app: heartbeat-cron
           bindings.knative.dev/include: "true"
       spec:
         template:
           metadata:
             annotations:
               sidecar.istio.io/inject: "true" 2
               sidecar.istio.io/rewriteAppHTTPProbers: "true"
           spec:
             restartPolicy: Never
             containers:
               - name: single-heartbeat
                 image: quay.io/openshift-knative/heartbeats:latest
                 args:
                   - --period=1
                 env:
                   - name: ONE_SHOT
                     value: "true"
                   - name: POD_NAME
                     valueFrom:
                       fieldRef:
                         fieldPath: metadata.name
                   - name: POD_NAMESPACE
                     valueFrom:
                       fieldRef:
                         fieldPath: metadata.namespace

   1

   ServiceMeshMemberRoll のメンバーである namespace。

   2

   Service Mesh サイドカーを CronJob Pod に挿入します。

6. CronJob リソースを適用します。

   $ oc apply -f <filename>

1. 以下のコマンドを入力します。

   $ oc get pods

2. 以下のコマンドを入力します。

   $ oc logs $(oc get pod -o name | grep event-display) -c user-container

   出力例

   ☁️  cloudevents.Event
   Validation: valid
   Context Attributes,
     specversion: 1.0
     type: dev.knative.eventing.samples.heartbeat
     source: https://knative.dev/eventing/test/heartbeats/#event-test/mypod
     id: 2b72d7bf-c38f-4a98-a433-608fbcdd2596
     time: 2019-10-18T15:23:20.809775386Z
     contenttype: application/json
   Extensions,
     beats: true
     heart: yes
     the: 42
   Data,
     {
       "id": 1,
       "label": ""
     }

手順

1. Developer パースペクティブで、+Add Event Source に移動します。Event Sources ページが表示されます。
2. Container Source を選択してから Create Event Source をクリックします。Create Event Source ページが表示されます。

3. Form view または YAML view を使用して、Container Source 設定を設定します。

   注記

   Form view と YAML view 間で切り換えることができます。ビューの切り替え時に、データは永続化されます。

   1. Image フィールドに、コンテナーソースが作成したコンテナーで実行するイメージの URI を入力します。
   2. Name フィールドにイメージの名前を入力します。
   3. オプション: Arguments フィールドで、コンテナーに渡す引数を入力します。
   4. オプション: Environment variables フィールドで、コンテナーに設定する環境変数を追加します。

   5. Target セクションで、イベントシンクを選択します。これは Resource または URI のいずれかです。

      1. Resource を選択して、チャネル、ブローカー、またはサービスをイベントソースのシンクとして使用します。
      2. URI を選択して、イベントのルーティング先となる URI (Uniform Resource Identifier) を指定します。
4. コンテナーソースの設定が完了したら、Create をクリックします。

手順

1. ServiceMeshMemberRoll のメンバーである namespace に Service を作成します。

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: event-display
     namespace: <namespace> 1
   spec:
     template:
       metadata:
         annotations:
           sidecar.istio.io/inject: "true" 2
           sidecar.istio.io/rewriteAppHTTPProbers: "true"
       spec:
         containers:
         - image: quay.io/openshift-knative/showcase

   1

   ServiceMeshMemberRoll のメンバーである namespace。

   2

   Service Mesh サイドカーは Knative サービス Pod に挿入します。

2. Service リソースを適用します。

   $ oc apply -f <filename>

3. ServiceMeshMemberRoll のメンバーである namespace に ContainerSource オブジェクトを作成し、event-display に設定されたシンクを作成します。

   apiVersion: sources.knative.dev/v1
   kind: ContainerSource
   metadata:
     name: test-heartbeats
     namespace: <namespace> 1
   spec:
     template:
       metadata: 2
         annotations:
           sidecar.istio.io/inject: "true"
           sidecar.istio.io/rewriteAppHTTPProbers: "true"
       spec:
         containers:
           - image: quay.io/openshift-knative/heartbeats:latest
             name: heartbeats
             args:
               - --period=1s
             env:
               - name: POD_NAME
                 value: "example-pod"
               - name: POD_NAMESPACE
                 value: "event-test"
     sink:
       ref:
         apiVersion: serving.knative.dev/v1
         kind: Service
         name: event-display

   1

   namespace は ServiceMeshMemberRoll の一部です。

   2

   Service Mesh と ContainerSource オブジェクトの統合を有効にします

4. ContainerSource リソースを適用します。

   $ oc apply -f <filename>

1. 以下のコマンドを入力します。

   $ oc get pods

2. 以下のコマンドを入力します。

   $ oc logs $(oc get pod -o name | grep event-display) -c user-container

   出力例

   ☁️  cloudevents.Event
   Validation: valid
   Context Attributes,
     specversion: 1.0
     type: dev.knative.eventing.samples.heartbeat
     source: https://knative.dev/eventing/test/heartbeats/#event-test/mypod
     id: 2b72d7bf-c38f-4a98-a433-608fbcdd2596
     time: 2019-10-18T15:23:20.809775386Z
     contenttype: application/json
   Extensions,
     beats: true
     heart: yes
     the: 42
   Data,
     {
       "id": 1,
       "label": ""
     }