5.12. サブスクリプションの作成および管理

前提条件

• OpenShift Serverless Operator、Knative Serving、および Knative Eventing が OpenShift Container Platform クラスターにインストールされている。
• Web コンソールにログインしている。
• Knative サービスおよびチャネルなどのイベントシンクを作成している。
• OpenShift Container Platform でアプリケーションおよび他のワークロードを作成するために、プロジェクトを作成しているか、適切なロールおよびパーミッションを持つプロジェクトにアクセスできる。

検証

• サブスクリプションの作成後に、これを Topology ビューでチャネルをサービスに接続する行として表示できます。

  

前提条件

• OpenShift Serverless Operator および Knative Eventing がクラスターにインストールされている。
• OpenShift CLI (oc) をインストールしている。
• OpenShift Container Platform でアプリケーションおよび他のワークロードを作成するために、プロジェクトを作成しているか、適切なロールおよびパーミッションを持つプロジェクトにアクセスできる。

手順

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

  • YAML ファイルを作成し、以下のサンプルコードをこれにコピーします。

    apiVersion: messaging.knative.dev/v1beta1
    kind: Subscription
    metadata:
      name: my-subscription 1
      namespace: default
    spec:
      channel: 2
        apiVersion: messaging.knative.dev/v1beta1
        kind: Channel
        name: example-channel
      delivery: 3
        deadLetterSink:
          ref:
            apiVersion: serving.knative.dev/v1
            kind: Service
            name: error-handler
      subscriber: 4
        ref:
          apiVersion: serving.knative.dev/v1
          kind: Service
          name: event-display

    1

    サブスクリプションの名前。

    2

    サブスクリプションが接続するチャネルの設定。

    3

    イベント配信の設定。これは、サブスクリプションに対してサブスクライバーに配信できないイベントに何が発生するかについて示します。これが設定されると、使用できないイベントが deadLetterSink に送信されます。イベントがドロップされると、イベントの再配信は試行されず、エラーのログがシステムに記録されます。deadLetterSink 値は Destination である必要があります。

    4

    サブスクライバーの設定。これは、イベントがチャネルから送信されるイベントシンクです。

  • YAML ファイルを適用します。

    $ oc apply -f <filename>

前提条件

• OpenShift Serverless Operator および Knative Eventing が OpenShift Container Platform クラスターにインストールされている。
• Knative (kn) CLI をインストールしている。
• OpenShift Container Platform でアプリケーションおよび他のワークロードを作成するために、プロジェクトを作成しているか、適切なロールおよびパーミッションを持つプロジェクトにアクセスできる。

手順

• サブスクリプションを作成し、シンクをチャネルに接続します。

  $ kn subscription create <subscription_name> \
    --channel <group:version:kind>:<channel_name> \ 1
    --sink <sink_prefix>:<sink_name> \ 2
    --sink-dead-letter <sink_prefix>:<sink_name> 3

  1

  --channel は、処理する必要のあるクラウドイベントのソースを指定します。チャネル名を指定する必要があります。Channel カスタムリソースでサポートされるデフォルトの InMemoryChannel チャネルを使用しない場合には、チャネル名に指定されたチャネルタイプの <group:version:kind> の接頭辞を付ける必要があります。たとえば、これは Kafka 対応チャネルの messaging.knative.dev:v1beta1:KafkaChannel のようになります。

  2

  --sink は、イベントが配信されるターゲット宛先を指定します。デフォルトで、<sink_name> は、サブスクリプションと同じ namespace でこの名前の Knative サービスとして解釈されます。以下の接頭辞のいずれかを使用して、シンクのタイプを指定できます。

  ksvc

  Knative サービス

  channel

  宛先として使用する必要のあるチャネル。ここで参照できるのは、デフォルトのチャネルタイプのみです。

  broker

  Eventing ブローカー。

  3

  オプション: --sink-dead-letter は、イベントが配信に失敗する場合にイベントを送信するシンクを指定するために使用できるオプションのフラグです。詳細は、OpenShift Serverless の Event 配信についてのドキュメントを参照してください。

  コマンドの例

  $ kn subscription create mysubscription --channel mychannel --sink ksvc:event-display

  出力例

  Subscription 'mysubscription' created in namespace 'default'.

検証

• サブスクリプションを使用してチャネルがイベントシンクまたは サブスクライバー に接続されていることを確認するには、既存のサブスクリプションを一覧表示し、出力を検査します。

  $ kn subscription list

  出力例

  NAME            CHANNEL             SUBSCRIBER           REPLY   DEAD LETTER SINK   READY   REASON
  mysubscription   Channel:mychannel   ksvc:event-display                              True

サブスクリプションの削除

• サブスクリプションを削除します。

  $ kn subscription delete <subscription_name>

前提条件

• Knative (kn) CLI をインストールしている。
• クラスターにサブスクリプションを作成している。

手順

• サブスクリプションを記述します。

  $ kn subscription describe <subscription_name>

  出力例

  Name:            my-subscription
  Namespace:       default
  Annotations:     messaging.knative.dev/creator=openshift-user, messaging.knative.dev/lastModifier=min ...
  Age:             43s
  Channel:         Channel:my-channel (messaging.knative.dev/v1)
  Subscriber:
    URI:           http://edisplay.default.example.com
  Reply:
    Name:          default
    Resource:      Broker (eventing.knative.dev/v1)
  DeadLetterSink:
    Name:          my-sink
    Resource:      Service (serving.knative.dev/v1)
  
  Conditions:
    OK TYPE                  AGE REASON
    ++ Ready                 43s
    ++ AddedToChannel        43s
    ++ ChannelReady          43s
    ++ ReferencesResolved    43s

前提条件

• Knative (kn) CLI をインストールしている。

手順

• クラスターのサブスクリプションを一覧表示します。

  $ kn subscription list

  出力例

  NAME             CHANNEL             SUBSCRIBER           REPLY   DEAD LETTER SINK   READY   REASON
  mysubscription   Channel:mychannel   ksvc:event-display                              True

前提条件

• Knative (kn) CLI をインストールしている。
• サブスクリプションを作成している。

手順

• サブスクリプションを更新します。

  $ kn subscription update <subscription_name> \
    --sink <sink_prefix>:<sink_name> \ 1
    --sink-dead-letter <sink_prefix>:<sink_name> 2

  1

  --sink は、イベントが配信される、更新されたターゲット宛先を指定します。以下の接頭辞のいずれかを使用して、シンクのタイプを指定できます。

  ksvc

  Knative サービス

  channel

  宛先として使用する必要のあるチャネル。ここで参照できるのは、デフォルトのチャネルタイプのみです。

  broker

  Eventing ブローカー。

  2

  オプション: --sink-dead-letter は、イベントが配信に失敗する場合にイベントを送信するシンクを指定するために使用できるオプションのフラグです。詳細は、OpenShift Serverless の Event 配信についてのドキュメントを参照してください。

  コマンドの例

  $ kn subscription update mysubscription --sink ksvc:event-display

• イベントがイベントシンクに配信されなかった場合に適用されるイベント配信パラメーターを設定します。イベント配信パラメーターの設定例 を参照してください。