8.2.6. リスナーの汎用リスナー設定への更新

AMQ Streams では、Kafka リソースの Kafka リスナーを設定するための Generic KafkaListener スキーマが提供されます。

GenericKafkaListener は、AMQ Streams から削除された KafkaListeners スキーマに置き換わりま した。

GenericKafkaListener スキーマ を使用すると、名前とポートが一意であれば、必要なリスナーをいくつでも設定できます。リスナー設定 は配列として定義されますが、非推奨の形式もサポートされます。

OpenShift クラスター内のクライアントの場合は、プレーン (暗号化なし)または tls 内部 リスナーを作成できます。

OpenShift クラスター外のクライアントの場合は、外部リスナー を作成し、nodeportloadbalanceringress、または route などの接続メカニズムを指定します。

KafkaListeners スキーマは、plain、tlsおよび external リスナーのサブプロパティーを使用し、それぞれに固定ポートを使用していました。アップグレードプロセスの段階で、KafkaListeners スキーマを使用して設定されたリスナーを GenericKafkaListener スキーマの形式に変換する必要があります。

たとえば、現在 Kafka 設定で以下の設定を使用しているとします。

これまでのリスナー設定

listeners:
  plain:
    # ...
  tls:
    # ...
  external:
    type: loadbalancer
    # ...

以下を使用して、リスナーを新しい形式に変換します。

新しいリスナー設定

listeners:
  #...
  - name: plain
    port: 9092
    type: internal
    tls: false 1
  - name: tls
    port: 9093
    type: internal
    tls: true
  - name: external
    port: 9094
    type: EXTERNAL-LISTENER-TYPE 2
    tls: true

1
すべてのリスナーに TLS プロパティーが必要になります。
2
オプション: ingressloadbalancernodeportroute

必ず 正確な 名前とポート番号を使用してください。

古い形式で 使用される追加の 設定または オーバーライド プロパティーについては、新しい形式に更新する必要があります。

リスナー設定 に導入された変更:

  • overridesconfiguration セクションとマージされます。
  • dnsAnnotations の名前が アノテーションになりました。
  • preferredAddressType の名前が preferredNodePortAddressType
  • address の名前が alternativeNames
  • loadBalancerSourceRanges および externalTrafficPolicy が、現在の非推奨の テンプレートからリスナー設定に移動します。

例として、以下の設定を見てみましょう。

従来の追加リスナー設定

listeners:
  external:
    type: loadbalancer
    authentication:
      type: tls
    overrides:
      bootstrap:
        dnsAnnotations:
          #...

これを以下に変更します。

新しい追加リスナー設定

listeners:
    #...
  - name: external
    port: 9094
    type:loadbalancer
    tls: true
    authentication:
      type: tls
    configuration:
      bootstrap:
        annotations:
          #...

重要

後方互換性を維持するため、新しいリスナー設定にある名前およびポート番号を使用する 必要 があります。他の値を使用すると、Kafka リスナーおよび OpenShift サービスの名前が変更されます。

各タイプのリスナーで利用可能な設定オプションの詳細は、「 GenericKafkaListener スキーマ参照」 を参照してください。