Language:
Format:

第13章カスタムリソース API のリファレンス

13.1. 共通の設定プロパティー

共通設定プロパティーは複数のリソースに適用されます。

13.1.1. `replicas`

replicas プロパティーを使用してレプリカを設定します。

レプリケーションのタイプはリソースによって異なります。

KafkaTopic はレプリケーション係数を使用して、Kafka クラスター内のパーティションごとのレプリカ数を設定します。
Kafka コンポーネントはレプリカを使用してデプロイメントの Pod 数を設定し、可用性とスケーラビリティーを向上します。

注記

OpenShift で Kafka コンポーネントを実行している場合、高可用性のために複数のレプリカを実行する必要がない場合があります。コンポーネントがデプロイされたノードがクラッシュすると、OpenShift によって自動的に Kafka コンポーネント Pod が別のノードに再スケジュールされます。ただし、複数のレプリカで Kafka コンポーネントを実行すると、他のノードが稼働しているため、フェイルオーバー時間が短縮されます。

13.1.2. `bootstrapServers`

bootstrapServers プロパティーを使用してブートストラップサーバーのリストを設定します。

ブートストラップサーバーリストは、同じ OpenShift クラスターにデプロイされていない Kafka クラスターを参照できます。AMQ Streams によってデプロイされた Kafka クラスターを参照することもできます。

同じ OpenShift クラスターである場合、各リストに CLUSTER-NAME-kafka-bootstrap という名前の Kafka クラスターブートストラップサービスとポート番号が含まれる必要がありますAMQ Streams によって異なる OpenShift クラスターにデプロイされた場合、リストの内容はクラスターを公開するために使用された方法によって異なります (route、ingress、nodeport、または loadbalancer)。

AMQ Streams によって管理されない Kafka クラスターで Kafka を使用する場合は、指定のクラスターの設定に応じてブートストラップサーバーのリストを指定できます。

13.1.3. `ssl`

TLS バージョンの特定の 暗号スイート を使用して、クライアント接続に許可される 3 つの ssl 設定オプションを使用します。暗号スイートは、セキュアな接続とデータ転送のためのアルゴリズムを組み合わせます。

また、ssl.endpoint.identification.algorithm プロパティーを設定して、ホスト名の検証を有効または無効にすることもできます。

SSL の設定例

# ...
spec:
  config:
    ssl.cipher.suites: "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" 1
    ssl.enabled.protocols: "TLSv1.2" 2
    ssl.protocol: "TLSv1.2" 3
    ssl.endpoint.identification.algorithm: HTTPS 4
# ...

1: TLS の暗号スイートは、ECDHE 鍵交換メカニズム、RSA 認証アルゴリズム、AES 一括暗号化アルゴリズム、および SHA384 MAC アルゴリズムの組み合わせを使用します。
2: SSI プロトコル TLSv1.2 は有効になります。
3: TLSv1.2 プロトコルを指定し、SSL コンテキスト生成します。許可される値は TLSv1.1 および TLSv1.2 です。
4: ホスト名の検証は HTTPS を設定して有効にします。空の文字列を指定すると検証が無効になります。

13.1.4. `trustedCertificates`

tls を設定して TLS による暗号化を設定したら、trustedCertificates プロパティーを使用して、証明書が X.509 形式で保存される鍵の名前でシークレットの一覧を提供します。

Kafka クラスターの Cluster Operator によって作成されるシークレットを使用するか、独自の TLS 証明書ファイルを作成してから、ファイルから Secret を作成できます。

oc create secret generic MY-SECRET \
--from-file=MY-TLS-CERTIFICATE-FILE.crt

TLS による暗号化の設定例

tls:
  trustedCertificates:
    - secretName: my-cluster-cluster-cert
      certificate: ca.crt
    - secretName: my-cluster-cluster-cert
      certificate: ca2.crt

複数の証明書が同じシークレットに保存されている場合は、複数回リストできます。

TLS を有効にし、Java に同梱されるデフォルトの公開認証局のセットを使用する場合は、trustedCertificates を空の配列として指定します。

デフォルトの Java 証明書で TLS を有効にする例

tls:
  trustedCertificates: []

TLS クライアント認証の設定に関する詳細は、「KafkaClientAuthenticationTlsスキーマ参照」を参照してください。

13.1.5. `resources`

コンポーネントの CPU およびメモリーリソースを要求します。制限によって、指定のコンテナーが消費可能な最大リソースが指定されます。

Topic Operator および User Operator のリソース要求および制限は Kafka リソースに設定されます。

reources.requests および resources.limits プロパティーを使用して、リソース要求および制限を設定します。

AMQ Streams では、デプロイされたコンテナーごとに特定のリソースを要求し、これらのリソースの最大消費を定義できます。

AMQ Streams では、以下のリソースタイプの要求および制限がサポートされます。

cpu
memory

AMQ Streams では、このようなリソースの指定に OpenShift の構文が使用されます。

OpenShift におけるコンピュートリソースの管理に関する詳細は、「Managing Compute Resources for Containers」を参照してください。

リソース要求

要求によって、指定のコンテナーに対して予約するリソースが指定されます。リソースを予約すると、リソースが常に利用できるようになります。

重要

リソース要求が OpenShift クラスターで利用可能な空きリソースを超える場合、Pod はスケジュールされません。

1 つまたは複数のサポートされるリソースに対してリクエストを設定できます。

リソース要求の設定例

# ...
resources:
  requests:
    cpu: 12
    memory: 64Gi
# ...

リソース制限

制限によって、指定のコンテナーが消費可能な最大リソースが指定されます。制限は予約されず、常に利用できるとは限りません。コンテナーは、リソースが利用できる場合のみ、制限以下のリソースを使用できます。リソース制限は、常にリソース要求よりも高くする必要があります。

1 つまたは複数のサポートされる制限に対してリソースを設定できます。

リソース制限の設定例

# ...
resources:
  limits:
    cpu: 12
    memory: 64Gi
# ...

サポートされる CPU 形式

CPU の要求および制限は以下の形式でサポートされます。

整数値 (5 CPU コア) または少数 (2.5 CPU コア) の CPU コアの数。
数値または ミリ CPU / ミリコア (100m)。1000 ミリコア は 1 CPU コアと同じです。

CPU ユニットの例

# ...
resources:
  requests:
    cpu: 500m
  limits:
    cpu: 2.5
# ...

注記

1 つの CPU コアのコンピューティング能力は、OpenShift がデプロイされたプラットフォームによって異なることがあります。

CPU 仕様の詳細は、「Meaning of CPU」を参照してください。

サポートされるメモリー形式

メモリー要求および制限は、メガバイト、ギガバイト、メビバイト、およびギビバイトで指定されます。

メモリーをメガバイトで指定するには、M 接尾辞を使用します。例: 1000M
メモリーをギガバイトで指定するには、G 接尾辞を使用します。例: 1G
メモリーをメビバイトで指定するには、Mi 接尾辞を使用します。例: 1000Mi
メモリーをギビバイトで指定するには、Gi 接尾辞を使用します。例: 1Gi

異なるメモリー単位を使用するリソースの例

# ...
resources:
  requests:
    memory: 512Mi
  limits:
    memory: 2Gi
# ...

メモリーの指定およびサポートされるその他の単位に関する詳細は、「Meaning of memory」を参照してください。

13.1.6. `image`

image プロパティーを使用して、コンポーネントによって使用されるコンテナーイメージを設定します。

コンテナーイメージのオーバーライドは、別のコンテナーレジストリーやカスタマイズされたイメージを使用する必要がある特別な状況でのみ推奨されます。

たとえば、ネットワークで AMQ Streams によって使用されるコンテナーリポジトリーへのアクセスが許可されない場合、AMQ Streams イメージのコピーまたはソースからのビルドを行うことができます。しかし、設定したイメージが AMQ Streams イメージと互換性のない場合は、適切に機能しない可能性があります。

コンテナーイメージのコピーはカスタマイズでき、デバッグに使用されることもあります。

以下のリソースの image プロパティーを使用すると、コンポーネントに使用するコンテナーイメージを指定できます。

Kafka.spec.kafka
Kafka.spec.zookeeper
Kafka.spec.entityOperator.topicOperator
Kafka.spec.entityOperator.userOperator
Kafka.spec.entityOperator.tlsSidecar
KafkaConnect.spec
KafkaConnectS2I.spec
KafkaMirrorMaker.spec
KafkaMirrorMaker2.spec
KafkaBridge.spec

Kafka、Kafka Connect、および Kafka MirrorMaker の image プロパティーの設定

Kafka、Kafka Connect (S2I サポートのある Kafka Connect を含む)、および Kafka MirrorMaker では、複数のバージョンの Kafka がサポートされます。各コンポーネントには独自のイメージが必要です。異なる Kafka バージョンのデフォルトイメージは、以下の環境変数で設定されます。

STRIMZI_KAFKA_IMAGES
STRIMZI_KAFKA_CONNECT_IMAGES
STRIMZI_KAFKA_CONNECT_S2I_IMAGES
STRIMZI_KAFKA_MIRROR_MAKER_IMAGES

これらの環境変数には、Kafka バージョンと対応するイメージ間のマッピングが含まれます。マッピングは、image および version プロパティーとともに使用されます。

image と version のどちらもカスタムリソースに指定されていない場合、version は Cluster Operator のデフォルトの Kafka バージョンに設定され、環境変数のこのバージョンに対応するイメージが指定されます。
image が指定されていても version が指定されていない場合、指定されたイメージが使用され、Cluster Operator のデフォルトの Kafka バージョンが version であると想定されます。
version が指定されていても image が指定されていない場合、環境変数の指定されたバージョンに対応するイメージが使用されます。
version と image の両方を指定すると、指定されたイメージが使用されます。このイメージには、指定のバージョンの Kafka イメージが含まれると想定されます。

異なるコンポーネントの image および version は、以下のプロパティーで設定できます。

Kafka の場合は spec.kafka.image および spec.kafka.version。
Kafka Connect、Kafka Connect S2I、および Kafka MirrorMaker の場合は spec.image および spec.version。

警告

version のみを提供し、image プロパティーを未指定のままにしておくことが推奨されます。これにより、カスタムリソースの設定時に間違いが発生する可能性が低減されます。異なるバージョンの Kafka に使用されるイメージを変更する必要がある場合は、Cluster Operator の環境変数を設定することが推奨されます。

他のリソースでの image プロパティーの設定

他のカスタムリソースの image プロパティーでは、デプロイメント中に指定の値が使用されます。image プロパティーがない場合、Cluster Operator 設定に指定された image が使用されます。image 名が Cluster Operator 設定に定義されていない場合、デフォルト値が使用されます。

Topic Operator の場合:
1. Cluster Operator 設定から STRIMZI_DEFAULT_TOPIC_OPERATOR_IMAGE 環境変数に指定されたコンテナーイメージ。
2. registry.redhat.io/amq7/amq-streams-rhel7-operator:1.7.0 コンテナーイメージ。
User Operator の場合:
1. Cluster Operator 設定から STRIMZI_DEFAULT_USER_OPERATOR_IMAGE 環境変数に指定されたコンテナーイメージ。
2. registry.redhat.io/amq7/amq-streams-rhel7-operator:1.7.0 コンテナーイメージ。
Entity Operator TLS サイドカーの場合:
1. Cluster Operator 設定から STRIMZI_DEFAULT_TLS_SIDECAR_ENTITY_OPERATOR_IMAGE 環境変数に指定されたコンテナーイメージ。
2. registry.redhat.io/amq7/amq-streams-kafka-27-rhel7:1.7.0 コンテナーイメージ。
Kafka Exporter の場合:
1. Cluster Operator 設定から STRIMZI_DEFAULT_KAFKA_EXPORTER_IMAGE 環境変数に指定されたコンテナーイメージ。
2. registry.redhat.io/amq7/amq-streams-kafka-27-rhel7:1.7.0 コンテナーイメージ。
Kafka Bridge の場合:
1. Cluster Operator 設定から STRIMZI_DEFAULT_KAFKA_BRIDGE_IMAGE 環境変数に指定されたコンテナーイメージ。
2. registry.redhat.io/amq7/amq-streams-bridge-rhel7:1.7.0 コンテナーイメージ。
Kafka ブローカーイニシャライザーの場合:
1. Cluster Operator 設定から STRIMZI_DEFAULT_KAFKA_INIT_IMAGE 環境変数に指定されたコンテナーイメージ。
2. registry.redhat.io/amq7/amq-streams-rhel7-operator:1.7.0 コンテナーイメージ。

コンテナーイメージ設定の例

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
spec:
  kafka:
    # ...
    image: my-org/my-image:latest
    # ...
  zookeeper:
    # ...

13.1.7. `livenessProbe` および `readinessProbe` ヘルスチェック

livenessProbe および readinessProbe プロパティーを使用して、AMQ Streams でサポートされるヘルスチェックプローブを設定します。

ヘルスチェックは、アプリケーションの健全性を検証する定期的なテストです。ヘルスチェックプローブが失敗すると、OpenShift によってアプリケーションが正常でないと見なされ、その修正が試行されます。

プローブの詳細は、「Configure Liveness and Readiness Probes」を参照してください。

livenessProbe および readinessProbe の両方によって以下のオプションがサポートされます。

initialDelaySeconds
timeoutSeconds
periodSeconds
successThreshold
failureThreshold

Liveness および Readiness プローブの設定例

# ...
readinessProbe:
  initialDelaySeconds: 15
  timeoutSeconds: 5
livenessProbe:
  initialDelaySeconds: 15
  timeoutSeconds: 5
# ...

livenessProbe および readinessProbe オプションの詳細については、「Probe スキーマ参照」を参照してください。

13.1.8. `metricsConfig`

metricsConfig プロパティーを使用して、Prometheus メトリクスを有効化および設定します。

metricsConfig プロパティーには、Prometheus JMX エスクポーターの追加設定が含まれる ConfigMap への参照が含まれます。AMQ Streams では、Apache Kafka および ZooKeeper によってサポートされる JMX メトリクスを Prometheus メトリクスに変換するために、Prometheus JMX エクスポーターを使用した Prometheus メトリクスがサポートされます。

追加設定なしで Prometheus メトリクスのエクスポートを有効にするには、metricsConfig.valueFrom.configMapKeyRef.key 下で空のファイルが含まれる ConfigMap を参照します。空のファイルを参照する場合、名前が変更されていない限り、すべてのメトリクスが公開されます。

Kafka のメトリクス設定が含まれる ConfigMap の例

kind: ConfigMap
apiVersion: v1
metadata:
  name: my-configmap
data:
  my-key: |
    lowercaseOutputName: true
    rules:
    # Special cases and very specific rules
    - pattern: kafka.server<type=(.+), name=(.+), clientId=(.+), topic=(.+), partition=(.*)><>Value
      name: kafka_server_$1_$2
      type: GAUGE
      labels:
       clientId: "$3"
       topic: "$4"
       partition: "$5"
    # further configuration

Kafka のメトリクス設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
spec:
  kafka:
    # ...
    metricsConfig:
      type: jmxPrometheusExporter
      valueFrom:
        configMapKeyRef:
          name: my-config-map
          key: my-key
    # ...
  zookeeper:
    # ...

有効になったメトリクスは、9404 番ポートで公開されます。

metricsConfig (または非推奨となった metrics) プロパティーがリソースに定義されていない場合、Prometheus メトリクスは無効になります。

Prometheus および Grafana の設定およびデプロイに関する詳細は、『OpenShift での AMQ Streams のデプロイおよびアップグレード』の「Kafka へのメトリクスの導入」を参照してください。

13.1.9. `jvmOptions`

以下の AMQ Streams コンポーネントは、Java 仮想マシン (JVM) 内で実行されます。

Apache Kafka
Apache ZooKeeper
Apache Kafka Connect
Apache Kafka MirrorMaker
AMQ Streams Kafka Bridge

異なるプラットフォームやアーキテクチャーでパフォーマンスを最適化するには、以下のリソースで jvmOptions プロパティーを設定します。

Kafka.spec.kafka
Kafka.spec.zookeeper
KafkaConnect.spec
KafkaConnectS2I.spec
KafkaMirrorMaker.spec
KafkaMirrorMaker2.spec
KafkaBridge.spec

設定では、以下のオプションを指定できます。

-Xms: JVM の起動時に最初に割り当てられる最小ヒープサイズ。
-Xmx: 最大ヒープサイズ。
-XX: JVM の高度なランタイムオプション。
javaSystemProperties: 追加のシステムプロパティー。
gcLoggingEnabled: ガベッジコレクターのロギングを有効にします。

jvmOptions の完全なスキーマは、「JvmOptions スキーマ参照」に記載されています。

注記

-Xmx や -Xms などの JVM 設定で使用できる単位は、対応するイメージの JDK java バイナリーで使用できる単位と同じです。そのため、1g または 1G は 1,073,741,824 バイトを意味し、Gi はサフィックスとして有効な単位ではありません。これは、1G は 1,000,000,000 バイトを意味し、1Gi は 1,073,741,824 バイトを意味する OpenShift の慣例に準拠しているメモリー要求および制限に使用される単位とは異なります。

-Xms および -Xmx オプション

-Xms および -Xmx に使用されるデフォルト値は、コンテナーにメモリー要求の制限が設定されているかどうかによって異なります。

メモリーの制限がある場合は、JVM の最小および最大メモリーは制限に対応する値に設定されます。
メモリーの制限がない場合、JVM の最小メモリーは 128M に設定されます。JVM の最大メモリーは、必要に応じてメモリーを拡張するようには定義されていません。これは、テストおよび開発での単一ノード環境に適しています。

-Xmx を明示的に設定する前に、以下を考慮してください。

JVM のメモリー使用量の合計は、-Xmx によって設定された最大ヒープの約 4 倍になります。
適切な OpenShift メモリー制限を設定せずに -Xmx が設定された場合、OpenShift ノードで、実行されている他の Pod からメモリー不足が発生するとコンテナーが強制終了される可能性があります。
適切な OpenShift メモリー要求を設定せずに -Xmx が設定された場合、コンテナーはメモリー不足のノードにスケジュールされる可能性があります。この場合、-Xms が -Xmx に設定されていると、コンテナーは起動せずに即座にクラッシュし、設定されていないと後でクラッシュします。

以下を行うことが推奨されます。

メモリー要求とメモリー制限を同じ値に設定します。
-Xmx の 4.5 倍以上のメモリー要求を使用します。
-Xms を -Xmx と同じ値に設定することを検討してください。

この例では、JVM のヒープに 2 GiB (2,147,483,648 バイト) が使用されます。メモリー使用量の合計は約 8GiB です。

-Xmx および -Xms の設定例

# ...
jvmOptions:
  "-Xmx": "2g"
  "-Xms": "2g"
# ...

最初のヒープサイズ (-Xms) および最大ヒープサイズ (-Xmx) に同じ値を設定すると、JVM が必要以上のヒープを割り当てて起動後にメモリーを割り当てないようにすることができます。

重要

Kafka ブローカーコンテナーなど、多数のディスク I/O を実行するコンテナーには、オペレーティングシステムのページキャッシュとして使用できるメモリーが必要です。このようなコンテナーでは、要求されるメモリーは JVM によって使用されるメモリーよりもはるかに多くなります。

-XX オプション

-XX オプションは、Apache Kafka の KAFKA_JVM_PERFORMANCE_OPTS オプションの設定に使用されます。

-XX の設定例

jvmOptions:
  "-XX":
    "UseG1GC": true
    "MaxGCPauseMillis": 20
    "InitiatingHeapOccupancyPercent": 35
    "ExplicitGCInvokesConcurrent": true

-XX 設定からの JVM オプション

-XX:+UseG1GC -XX:MaxGCPauseMillis=20 -XX:InitiatingHeapOccupancyPercent=35 -XX:+ExplicitGCInvokesConcurrent -XX:-UseParNewGC

注記

-XX オプションを指定しないと、Apache Kafka のデフォルト設定 KAFKA_JVM_PERFORMANCE_OPTS が使用されます。

javaSystemProperties

javaSystemProperties は、デバッグユーティリティーなどの追加の Java システムプロパティーの設定に使用されます。

javaSystemProperties の設定例

jvmOptions:
  javaSystemProperties:
    - name: javax.net.debug
      value: ssl

13.1.10. ガベッジコレクターのロギング

jvmOptions プロパティーでは、ガベージコレクター (GC) のロギングを有効または無効にすることもできます。GC ロギングはデフォルトで無効になっています。これを有効にするには、以下のように gcLoggingEnabled プロパティーを設定します。

GC ロギングの設定例

# ...
jvmOptions:
  gcLoggingEnabled: true
# ...

13.2. スキーマプロパティー

13.2.1. `Kafka` スキーマ参照

プロパティー	説明
spec	Kafka および ZooKeeper クラスター、Topic Operator の仕様。
`KafkaSpec`	Kafka および ZooKeeper クラスター、Topic Operator の仕様。
status	Kafka および ZooKeeper クラスター、Topic Operator のステータス。
`KafkaStatus`	Kafka および ZooKeeper クラスター、Topic Operator のステータス。

13.2.2. `KafkaSpec` スキーマ参照

Kafka で使用

プロパティー	説明
kafka	Kafka クラスターの設定。
`KafkaClusterSpec`	Kafka クラスターの設定。
zookeeper	ZooKeeper クラスターの設定。
`ZookeeperClusterSpec`	ZooKeeper クラスターの設定。
topicOperator	`topicOperator` プロパティーは非推奨となり、`spec.entityOperator.topicOperator` を使用して設定する必要があります。topicOperator プロパティーは API バージョン `v1beta2` で削除されます。Topic Operator の設定。
`TopicOperatorSpec`
entityOperator	Entity Operator の設定。
`EntityOperatorSpec`	Entity Operator の設定。
clusterCa	クラスター認証局の設定。
`CertificateAuthority`	クラスター認証局の設定。
clientsCa	クライアント認証局の設定。
`CertificateAuthority`	クライアント認証局の設定。
cruiseControl	Cruise Control デプロイメントの設定。指定時に Cruise Control インスタンスをデプロイします。
`CruiseControlSpec`
kafkaExporter	Kafka Exporter の設定。Kafka Exporter は追加のメトリクスを提供できます (例: トピック/パーティションでのコンシューマーグループのラグなど)。
`KafkaExporterSpec`
maintenanceTimeWindows	メンテナンスタスク (証明書の更新) 用の時間枠の一覧。それぞれの時間枠は、cron 式で定義されます。
string array	メンテナンスタスク (証明書の更新) 用の時間枠の一覧。それぞれの時間枠は、cron 式で定義されます。

13.2.3. `KafkaClusterSpec` スキーマ参照

KafkaSpec で使用

KafkaClusterSpec スキーマプロパティーの完全リスト

Kafka クラスターを設定します。

13.2.3.1. `listeners`

listeners プロパティーを使用して、Kafka ブローカーへのアクセスを提供するようにリスナーを設定します。

認証のないプレーン (暗号化されていない) リスナーの設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
spec:
  kafka:
    # ...
    listeners:
      - name: plain
        port: 9092
        type: internal
        tls: false
    # ...
  zookeeper:
    # ...

13.2.3.2. `config`

config プロパティーを使用して、Kafka ブローカーオプションをキーとして設定します。

標準の Apache Kafka 設定が提供されることがありますが、AMQ Streams によって直接管理されないプロパティーに限定されます。

以下に関連する設定オプションは設定できません。

セキュリティー (暗号化、認証、および承認)
リスナーの設定
Broker ID の設定
ログデータディレクトリーの設定
ブローカー間の通信
ZooKeeper の接続

値は以下の JSON タイプのいずれかになります。

文字列
数値
ブール値

AMQ Streams で直接管理されるオプションを除き、Apache Kafka ドキュメントに記載されているオプションを指定および設定できます。以下の文字列の 1 つと同じキーまたは以下の文字列の 1 つで始まるキーを持つ設定オプションはすべて禁止されています。

listeners
advertised.
broker.
listener.
host.name
port
inter.broker.listener.name
sasl.
ssl.
security.
password.
principal.builder.class
log.dir
zookeeper.connect
zookeeper.set.acl
authorizer.
super.user

禁止されているオプションが config プロパティーにある場合、そのオプションは無視され、警告メッセージが Cluster Operator ログファイルに出力されます。サポートされるその他すべてのオプションは Kafka に渡されます。

禁止されているオプションには例外があります。TLS バージョンに特定の 暗号スイート を使用するクライアント接続では、許可された ssl プロパティーを設定できます。zookeeper.connection.timeout.ms プロパティーを設定して、ZooKeeper 接続の確立に許可される最大時間も設定できます。

Kafka ブローカーの設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
spec:
  kafka:
    # ...
    config:
      num.partitions: 1
      num.recovery.threads.per.data.dir: 1
      default.replication.factor: 3
      offsets.topic.replication.factor: 3
      transaction.state.log.replication.factor: 3
      transaction.state.log.min.isr: 1
      log.retention.hours: 168
      log.segment.bytes: 1073741824
      log.retention.check.interval.ms: 300000
      num.network.threads: 3
      num.io.threads: 8
      socket.send.buffer.bytes: 102400
      socket.receive.buffer.bytes: 102400
      socket.request.max.bytes: 104857600
      group.initial.rebalance.delay.ms: 0
      ssl.cipher.suites: "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
      ssl.enabled.protocols: "TLSv1.2"
      ssl.protocol: "TLSv1.2"
      zookeeper.connection.timeout.ms: 6000
    # ...

13.2.3.3. `brokerRackInitImage`

ラックアウェアネス (Rack Awareness) が有効である場合、Kafka ブローカー Pod は init コンテナーを使用して OpenShift クラスターノードからラベルを収集します。このコンテナーに使用されるコンテナーイメージは、brokerRackInitImage プロパティーを使用して設定できます。brokerRackInitImage フィールドがない場合、優先順位順に以下のイメージが使用されます。

Cluster Operator 設定の STRIMZI_DEFAULT_KAFKA_INIT_IMAGE 環境変数に指定されたコンテナーイメージ。
registry.redhat.io/amq7/amq-streams-rhel7-operator:1.7.0 コンテナーイメージ。

brokerRackInitImage の設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
spec:
  kafka:
    # ...
    rack:
      topologyKey: topology.kubernetes.io/zone
    brokerRackInitImage: my-org/my-image:latest
    # ...

注記

コンテナーイメージのオーバーライドは、別のコンテナーレジストリーを使用する必要がある特別な状況でのみ推奨されます。たとえば、AMQ Streams によって使用されるコンテナーレジストリーにネットワークがアクセスできない場合などがこれに該当します。この場合は、AMQ Streams イメージをコピーするか、ソースからビルドする必要があります。設定したイメージが AMQ Streams イメージと互換性のない場合は、適切に機能しない可能性があります。

13.2.3.4. `logging`

Kafka には独自の設定可能なロガーがあります。

log4j.logger.org.I0Itec.zkclient.ZkClient
log4j.logger.org.apache.zookeeper
log4j.logger.kafka
log4j.logger.org.apache.kafka
log4j.logger.kafka.request.logger
log4j.logger.kafka.network.Processor
log4j.logger.kafka.server.KafkaApis
log4j.logger.kafka.network.RequestChannel$
log4j.logger.kafka.controller
log4j.logger.kafka.log.LogCleaner
log4j.logger.state.change.logger
log4j.logger.kafka.authorizer.logger

Kafka では Apache log4j ロガー実装が使用されます。

logging プロパティーを使用してロガーおよびロガーレベルを設定します。

ログレベルを設定するには、ロガーとレベルを直接指定 (インライン) するか、またはカスタム (外部) ConfigMap を使用します。ConfigMap を使用する場合、logging.valueFrom.configMapKeyRef.name プロパティーを外部ロギング設定が含まれる ConfigMap の名前に設定します。ConfigMap 内では、ロギング設定は log4j.properties を使用して記述されます。logging.valueFrom.configMapKeyRef.name および logging.valueFrom.configMapKeyRef.key プロパティーはいずれも必須です。Cluster Operator の実行時に、指定された正確なロギング設定を使用する ConfigMap がカスタムリソースを使用して作成され、その後は調整のたびに再作成されます。カスタム ConfigMap を指定しない場合、デフォルトのロギング設定が使用されます。特定のロガー値が設定されていない場合、上位レベルのロガー設定がそのロガーに継承されます。ログレベルの詳細は、「Apache logging services」を参照してください。

inline および external ロギングの例は次のとおりです。

inline ロギング

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
spec:
  # ...
  kafka:
    # ...
    logging:
      type: inline
      loggers:
        kafka.root.logger.level: "INFO"
  # ...

外部ロギング

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
spec:
  # ...
  logging:
    type: external
    valueFrom:
      configMapKeyRef:
        name: customConfigMap
        key: kafka-log4j.properties
  # ...

設定されていない利用可能なロガーのレベルは OFF に設定されています。

Cluster Operator を使用して Kafka がデプロイされた場合、Kafka のロギングレベルの変更は動的に適用されます。

外部ロギングを使用する場合は、ロギングアペンダーが変更されるとローリングアップデートがトリガーされます。

ガベッジコレクター (GC)

ガベッジコレクターのロギングは、jvmOptions プロパティーを使用して有効 (または無効) にすることもできます。

13.2.3.5. `KafkaClusterSpec` スキーマプロパティー

プロパティー	説明
version	Kafka ブローカーのバージョン。デフォルトは 2.7.0 です。バージョンのアップグレードまたはダウングレードに必要なプロセスを理解するには、ユーザードキュメントを参照してください。
string
replicas	クラスター内の Pod 数。
integer	クラスター内の Pod 数。
image	Pod の Docker イメージ。デフォルト値は、設定した `Kafka.spec.kafka.version` によって異なります。
string
listeners	Kafka ブローカーのリスナーを設定します。
`GenericKafkaListener` 配列または `KafkaListeners`	Kafka ブローカーのリスナーを設定します。
config	次の接頭辞のある Kafka ブローカーの config プロパティーは設定できません: listeners、advertised.、broker.、listener.、 host.name、port、inter.broker.listener.name、sasl.、ssl.、 security.、password.、principal.builder.class、log.dir、 zookeeper.connect、zookeeper.set.acl、zookeeper.ssl、zookeeper.clientCnxnSocket、authorizer.、super.user、cruise.control.metrics.topic、cruise.control.metrics.reporter.bootstrap.servers (次の例外を除く: zookeeper.connection.timeout.ms、ssl.cipher.suites、ssl.protocol、ssl.enabled.protocols,cruise.control.metrics.topic.num.partitions、cruise.control.metrics.topic.replication.factor、cruise.control.metrics.topic.retention.ms、cruise.control.metrics.topic.auto.create.retries、cruise.control.metrics.topic.auto.create.timeout.ms、cruise.control.metrics.topic.min.insync.replicas)
map
storage	ストレージの設定 (ディスク)。更新はできません。タイプは、指定のオブジェクト内の `storage.type` プロパティーの値によって異なり、[ephemeral、persistent-claim、jbod] のいずれかでなければなりません。
`EphemeralStorage`, `PersistentClaimStorage`, `JbodStorage`
authorization	Kafka ブローカーの承認設定。タイプは、指定のオブジェクト内の `authorization.type` プロパティーの値によって異なり、[simple、opa、keycloak] のいずれかでなければなりません。
`KafkaAuthorizationSimple`, `KafkaAuthorizationOpa`, `KafkaAuthorizationKeycloak`
rack	`broker.rack` ブローカー設定の設定
`Rack`	`broker.rack` ブローカー設定の設定
brokerRackInitImage	`broker.rack` の初期化に使用される init コンテナーのイメージ。
string	`broker.rack` の初期化に使用される init コンテナーのイメージ。
affinity	`affinity` プロパティーは非推奨となり、`spec.kafka.template.pod.affinity` を使用して設定する必要があります。affinity プロパティーは API バージョン `v1beta2` で削除されます。Pod のアフィニティールール。詳細は、core/v1 affinity の外部ドキュメントを参照してください。
Affinity
tolerations	`tolerations` プロパティーは非推奨となり、`spec.kafka.template.pod.tolerations` を使用して設定する必要があります。tolerations プロパティーは API バージョン `v1beta2` で削除されます。Pod の許容 (Toleration)。詳細は、core/v1 toleration の外部ドキュメントを参照してください。
Toleration array
livenessProbe	Pod の liveness チェック。
`Probe`	Pod の liveness チェック。
readinessProbe	Pod の readiness チェック。
`Probe`	Pod の readiness チェック。
jvmOptions	Pod の JVM オプション。
`JvmOptions`	Pod の JVM オプション。
jmxOptions	Kafka ブローカーの JMX オプション。
`KafkaJmxOptions`	Kafka ブローカーの JMX オプション。
resources	予約する CPU およびメモリーリソース。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements
metrics	`metrics` プロパティーは非推奨となり、`spec.kafka.metricsConfig` を使用して設定する必要があります。metrics プロパティーは API バージョン `v1beta2` で削除されます。Prometheus JMX エクスポーターの設定。この設定の構造に関する詳細は、https://github.com/prometheus/jmx_exporter を参照してください。
map
metricsConfig	メトリクスの設定。タイプは、指定のオブジェクト内の `metricsConfig.type` プロパティーの値によって異なり、[jmxPrometheusExporter] の 1 つでなければなりません。
`JmxPrometheusExporterMetrics`
logging	Kafka のロギング設定。タイプは、指定のオブジェクト内の `logging.type` プロパティーの値によって異なり、[inline、external] のいずれかでなければなりません。
`InlineLogging`, `ExternalLogging`
tlsSidecar	`tlsSidecar` プロパティーは非推奨となりました。tlsSidecar プロパティーは API バージョン `v1beta2` で削除されます。TLS サイドカーの設定。
`TlsSidecar`
template	Kafka クラスターリソースのテンプレート。テンプレートを使用すると、ユーザーは `StatefulSet`、`Pods`、および `Services` の生成方法を指定できます。
`KafkaClusterTemplate`

13.2.4. `GenericKafkaListener` スキーマ参照

KafkaClusterSpec で使用

GenericKafkaListener スキーマプロパティーの完全リスト

OpenShift 内外の Kafka ブローカーに接続するようにリスナーを設定します。

Kafka リソースでリスナーを設定します。

リスナー設定を示す Kafka リソースの例

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
spec:
  kafka:
    #...
    listeners:
      - name: plain
        port: 9092
        type: internal
        tls: false
      - name: tls
        port: 9093
        type: internal
        tls: true
        authentication:
          type: tls
      - name: external1
        port: 9094
        type: route
        tls: true
      - name: external2
        port: 9095
        type: ingress
        tls: true
        authentication:
          type: tls
        configuration:
          bootstrap:
            host: bootstrap.myingress.com
          brokers:
          - broker: 0
            host: broker-0.myingress.com
          - broker: 1
            host: broker-1.myingress.com
          - broker: 2
            host: broker-2.myingress.com
    #...

13.2.4.1. `listeners`

Kafka リソースの listeners プロパティーを使用して Kafka ブローカーリスナーを設定します。リスナーは配列として定義されます。

リスナーの設定例

listeners:
  - name: plain
    port: 9092
    type: internal
    tls: false

名前およびポートは Kafka クラスター内で一意である必要があります。名前は最大 25 文字で、小文字と数字で構成されます。許可されるポート番号は 9092 以上ですが、すでに Prometheus および JMX によって使用されているポート 9404 および 9999 以外になります。

各リスナーに一意の名前とポートを指定することで、複数のリスナーを設定できます。

13.2.4.2. `type`

タイプは internal と設定するか、外部リスナーの場合は route、loadbalancer、⁠nodeport、または ingress と設定します。

internal

tls プロパティーを使用すると、暗号化の有無に関わらず内部リスナーを設定できます。

internal リスナーの設定例

#...
spec:
  kafka:
    #...
    listeners:
      #...
      - name: plain
        port: 9092
        type: internal
        tls: false
      - name: tls
        port: 9093
        type: internal
        tls: true
        authentication:
          type: tls
    #...

route

OpenShift の Routes および HAProxy ルーターを使用して、Kafka を公開するように外部リスナーを設定します。

専用の Route がすべての Kafka ブローカー Pod に作成されます。追加の Route が作成され、Kafka ブートストラップアドレスとして提供されます。これらの Routes を使用すると、Kafka クライアントを 443 番ポートで Kafka に接続することができます。クライアントはデフォルトのルーターポートであるポート 443 に接続しますが、トラフィックは設定するポート (この例では 9094) にルーティングされます。

route リスナーの設定例

#...
spec:
  kafka:
    #...
    listeners:
      #...
      - name: external1
        port: 9094
        type: route
        tls: true
    #...

ingress

Kubernetes Ingress および NGINX Ingress Controller for Kubernetes を使用して Kafka を公開するように外部リスナーを設定します。

各 Kafka ブローカー Pod に専用の Ingress リソースが作成されます。追加の Ingress リソースが作成され、Kafka ブートストラップアドレスとして提供されます。これらの Ingress リソースを使用すると、Kafka クライアントを 443 番ポートで Kafka に接続することができます。クライアントはデフォルトのコントローラーポートであるポート 443 に接続しますが、トラフィックは設定するポート (以下の例では 9095) にルーティングされます。

GenericKafkaListenerConfigurationBootstrap および GenericKafkaListenerConfigurationBroker プロパティーを使用して、ブートストラップおよびブローカーごとのサービスによって使用されるホスト名を指定する必要があります。

ingress リスナーの設定例

#...
spec:
  kafka:
    #...
    listeners:
      #...
      - name: external2
        port: 9095
        type: ingress
        tls: true
        authentication:
          type: tls
        configuration:
          bootstrap:
            host: bootstrap.myingress.com
          brokers:
          - broker: 0
            host: broker-0.myingress.com
          - broker: 1
            host: broker-1.myingress.com
          - broker: 2
            host: broker-2.myingress.com
  #...

注記

Ingress を使用する外部リスナーは、現在 NGINX Ingress Controller for Kubernetes でのみテストされます。

loadbalancer

Kafka Loadbalancer タイプの Servicesを公開するように外部リスナーを設定します。

Kafka ブローカー Pod ごとに新しいロードバランサーサービスが作成されます。追加のロードバランサーが作成され、Kafka の ブートストラップ アドレスとして提供されます。Loadbalancer は指定のポート番号をリッスンします。これは以下の例ではポート 9094 になります。

loadBalancerSourceRanges プロパティーを使用してソース範囲を設定し、指定した IP アドレスへのアクセスを制限できます。

loadbalancer リスナーの設定例

#...
spec:
  kafka:
    #...
    listeners:
      - name: external3
        port: 9094
        type: loadbalancer
        tls: true
        configuration:
          loadBalancerSourceRanges:
            - 10.0.0.0/8
            - 88.208.76.87/32
    #...

nodeport

NodePort タイプの Services を使用して、Kafka を公開するように外部リスナーを設定します。

Kafka クライアントは OpenShift のノードに直接接続します。追加の NodePort タイプのサービスが作成され、Kafka ブートストラップアドレスとして提供されます。

Kafka ブローカー Pod にアドバタイズされたアドレスを設定する場合、AMQ Stremas では該当の Pod が稼働しているノードのアドレスが使用されます。preferredNodePortAddressType プロパティーを使用して、ノードアドレスとしてチェックされた最初のアドレスタイプを設定できます。

nodeport リスナーの設定例

#...
spec:
  kafka:
    #...
    listeners:
      #...
      - name: external4
        port: 9095
        type: nodeport
        tls: false
        configuration:
          preferredNodePortAddressType: InternalDNS
    #...

注記

ノードポートを使用して Kafka クラスターを公開する場合、現在 TLS ホスト名の検証はサポートされません。

13.2.4.3. `port`

ポート番号は Kafka クラスターで使用されるポートで、クライアントによるアクセスに使用されるポートとは異なる場合があります。

loadbalancer リスナーは、internal リスナーのように、指定されたポート番号を使用します。
ingress および route リスナーはアクセスにポート 443 を使用します。
nodeport リスナーは OpenShift によって割り当てられたポート番号を使用します。

クライアント接続の場合は、リスナーのブートストラップサービスのアドレスおよびポートを使用します。これは、Kafka リソースのステータスから取得できます。

クライアント接続のアドレスおよびポートを取得するコマンドの例

oc get kafka KAFKA-CLUSTER-NAME -o=jsonpath='{.status.listeners[?(@.type=="external")].bootstrapServers}{"\n"}'

注記

ブローカー間通信 (9091) およびメトリクス (9404) 用に確保されたポートを使用するようにリスナーを設定することはできません。

13.2.4.4. `tls`

TLS プロパティーが必要です。

デフォルトでは、TLS による暗号化は有効になっていません。これを有効にするには、tls プロパティーを true に設定します。

TLS による暗号化は、常に route リスナーと使用されます。

13.2.4.5. `authentication`

リスナーの認証は以下のように指定できます。

相互 TLS (tls)
SCRAM-SHA-512 (scram-sha-512)
トークンベース OAuth 2.0 (oauth)

13.2.4.6. `networkPolicyPeers`

ネットワークレベルでリスナーへのアクセスを制限するネットワークポリシーを設定するには、networkPolicyPeers を使用します。以下に、plain および tls リスナーの networkPolicyPeers 設定の例を示します。

listeners:
  #...
  - name: plain
    port: 9092
    type: internal
    tls: true
    authentication:
      type: scram-sha-512
    networkPolicyPeers:
      - podSelector:
          matchLabels:
            app: kafka-sasl-consumer
      - podSelector:
          matchLabels:
            app: kafka-sasl-producer
  - name: tls
    port: 9093
    type: internal
    tls: true
    authentication:
      type: tls
    networkPolicyPeers:
      - namespaceSelector:
          matchLabels:
            project: myproject
      - namespaceSelector:
          matchLabels:
            project: myproject2
# ...

この例では以下が設定されています。

ラベル app: kafka-sasl-consumer および app: kafka-sasl-producer と一致するアプリケーション Pod のみが plain リスナーに接続できます。アプリケーション Pod は Kafka ブローカーと同じ namespace で実行されている必要があります。
ラベル project: myproject および project: myproject2 と一致する namespace で稼働するアプリケーション Pod のみが tls リスナーに接続できます。

networkPolicyPeers フィールドの構文は、NetworkPolicy リソースの from フィールドと同じです。

KafkaListeners との後方互換性

GenericKafkaListener は、非推奨となった KafkaListeners スキーマを置き換えます。

KafkaListeners スキーマを使用して設定されたリスナーを、後方互換性を持つ GenericKafkaListener スキーマの形式に変換するには、以下の名前、ポート、およびタイプを使用します。

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

1: オプション: ingress、loadbalancer、nodeport、route

13.2.4.7. `GenericKafkaListener` スキーマプロパティー

プロパティー	説明
name	リスナーの名前。名前は、リスナーおよび関連する OpenShift オブジェクトの識別に使用されます。指定の Kafka クラスター内で一意となる必要があります。この名前には、小文字と数字を使用でき、最大 11 文字まで使用できます。
string
port	Kafka 内でリスナーによって使用されるポート番号。ポート番号は指定の Kafka クラスター内で一意である必要があります。許可されるポート番号は 9092 以上ですが、すでに Prometheus および JMX によって使用されているポート 9404 および 9999 以外になります。リスナーのタイプによっては、ポート番号は Kafka クライアントに接続するポート番号と同じではない場合があります。
integer
type	リスナーのタイプ。現在サポートされるタイプは、`internal`、`route`、`loadbalancer`、`nodeport`、および `ingress` です。 * `internal` タイプは、OpenShift クラスター内で Kafka を内部のみで公開します。* `route` タイプは OpenShift Routes を使用して Kafka を公開します。* `loadbalancer` タイプは LoadBalancer タイプのサービスを使用して Kafka を公開します。* `nodeport` タイプは NodePort タイプのサービスを使用して Kafka を公開します。* `ingress` タイプは OpenShift Nginx Ingress を使用して Kafka を公開します。
string ([ingress、internal、route、loadbalancer、nodeport] のいずれか)
tls	リスナーで TLS による暗号化を有効にします。これは必須プロパティーです。
boolean	リスナーで TLS による暗号化を有効にします。これは必須プロパティーです。
authentication	このリスナーの認証設定。タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[tls、scram-sha-512、oauth] のいずれかでなければなりません。
`KafkaListenerAuthenticationTls`, `KafkaListenerAuthenticationScramSha512`, `KafkaListenerAuthenticationOAuth`
configuration	追加のリスナー設定。
`GenericKafkaListenerConfiguration`	追加のリスナー設定。
networkPolicyPeers	このリスナーに接続できるピアの一覧。この一覧のピアは、論理演算子 OR を使用して組み合わせます。このフィールドが空であるか、または存在しない場合、このリスナーのすべてのコネクションが許可されます。このフィールドが存在し、1 つ以上の項目が含まれる場合、リスナーはこの一覧の少なくとも 1 つの項目と一致するトラフィックのみを許可します。詳細は、networking.k8s.io/v1 networkpolicypeer の外部ドキュメントを参照してください。
NetworkPolicyPeer array

13.2.5. `KafkaListenerAuthenticationTls` スキーマ参照

GenericKafkaListener、KafkaListenerExternalIngress、KafkaListenerExternalLoadBalancer、KafkaListenerExternalNodePort、KafkaListenerExternalRoute、KafkaListenerPlain、KafkaListenerTls で使用

type プロパティーは、KafkaListenerAuthenticationTls タイプの使用を KafkaListenerAuthenticationScramSha512、KafkaListenerAuthenticationOAuth と区別する識別子です。KafkaListenerAuthenticationTls タイプには tls の値が必要です。

プロパティー	説明
type	`tls` でなければなりません。
string	`tls` でなければなりません。

13.2.6. `KafkaListenerAuthenticationScramSha512` スキーマ参照

type プロパティーは、KafkaListenerAuthenticationScramSha512 タイプの使用を KafkaListenerAuthenticationTls、KafkaListenerAuthenticationOAuth と区別する識別子です。KafkaListenerAuthenticationScramSha512 タイプには scram-sha-512 の値が必要です。

プロパティー	説明
type	`scram-sha-512` でなければなりません。
string	`scram-sha-512` でなければなりません。

13.2.7. `KafkaListenerAuthenticationOAuth` スキーマ参照

type プロパティーは、KafkaListenerAuthenticationOAuth タイプの使用を KafkaListenerAuthenticationTls、KafkaListenerAuthenticationScramSha512 と区別する識別子です。KafkaListenerAuthenticationOAuth タイプには oauth の値が必要です。

プロパティー	説明
accessTokenIsJwt	アクセストークンを JWT として処理するかどうかを設定します。承認サーバーが不透明なトークンを返す場合は、`false` に設定する必要があります。デフォルトは `true` です。
boolean
checkAccessTokenType	アクセストークンタイプのチェックを行うかどうかを設定します。承認サーバーの JWT トークンに 'typ' 要求が含まれない場合は、`false` に設定する必要があります。デフォルトは `true` です。
boolean
checkAudience	オーディエンスのチェックを有効または無効にします。オーディエンスのチェックによって、トークンの受信者が特定されます。オーディエンスのチェックが有効な場合は、`clientId` プロパティーを使用して OAuth クライアント ID も設定する必要があります。Kafka ブローカーは、`aud` (オーディエンス) クレームに `clientId` のないトークンを拒否します。デフォルト値は `false` です。
boolean
checkIssuer	発行元のチェックを有効または無効にします。デフォルトでは、`validIssuerUri` によって設定された値を使用して発行元がチェックされます。デフォルト値は `true` です。
boolean
clientId	Kafka ブローカーは、OAuth クライアント ID を使用して承認サーバーに対して認証し、イントロスペクションエンドポイント URI を使用することができます。
string
clientSecret	OAuth クライアントシークレットが含まれる OpenShift シークレットへのリンク。Kafka ブローカーは、OAuth クライアントシークレットを使用して承認サーバーに対して認証し、イントロスペクションエンドポイント URI を使用することができます。
`GenericSecretSource`
customClaimCheck	JWT トークンに適用される JSONPath フィルタークエリー、または追加のトークン検証のイントロスペクションエンドポイントの応答に適用される JSONPath フィルタークエリー。デフォルトでは設定されません。
string
disableTlsHostnameVerification	TLS ホスト名の検証を有効または無効にします。デフォルト値は `false` です。
boolean	TLS ホスト名の検証を有効または無効にします。デフォルト値は `false` です。
enableECDSA	BouncyCastle 暗号プロバイダーをインストールして、ECDSA サポートを有効または無効にします。デフォルト値は `false` です。
boolean
enableOauthBearer	SASL_OAUTHBEARER での OAuth 認証を有効または無効にします。デフォルト値は `true` です。
boolean	SASL_OAUTHBEARER での OAuth 認証を有効または無効にします。デフォルト値は `true` です。
enablePlain	SASL_PLAIN で OAuth 認証を有効または無効にします。このメカニズムが使用される場合、再認証はサポートされません。デフォルト値は `false` です。
boolean
fallbackUserNameClaim	`userNameClaim` によって指定された要求が存在しない場合に、ユーザー ID に使用するフォールバックユーザー名要求。これは、`client_credentials` 認証によってクライアント ID が別の要求のみに提供される場合に便利です。`userNameClaim` が設定されている場合のみ有効です。
string
fallbackUserNamePrefix	ユーザー ID を構成するために `fallbackUserNameClaim` の値と使用される接頭辞。`fallbackUserNameClaim` が true で、要求の値が存在する場合のみ有効です。ユーザー名とクライアント ID を同じユーザー ID 領域にマッピングすると、名前の競合を防ぐことができ便利です。
string
introspectionEndpointUri	不透明な JWT 以外のトークンの検証に使用できるトークンイントロスペクションエンドポイントの URI。
string	不透明な JWT 以外のトークンの検証に使用できるトークンイントロスペクションエンドポイントの URI。
jwksEndpointUri	ローカルの JWT 検証に使用できる JWKS 証明書エンドポイントの URI。
string	ローカルの JWT 検証に使用できる JWKS 証明書エンドポイントの URI。
jwksExpirySeconds	JWKS 証明書が有効とみなされる頻度を設定します。期限切れの間隔は、`jwksRefreshSeconds` で指定される更新間隔よりも 60 秒以上長くする必要があります。デフォルトは 360 秒です。
integer
jwksMinRefreshPauseSeconds	連続する 2 回の更新の間に適用される最小の一時停止期間。不明な署名鍵が検出されると、更新は即座にスケジュールされますが、この最小一時停止の期間は待機します。デフォルトは 1 秒です。
integer
jwksRefreshSeconds	JWKS 証明書が更新される頻度を設定します。更新間隔は、`jwksExpirySeconds` で指定される期限切れの間隔よりも 60 秒以上短くする必要があります。デフォルトは 300 秒です。
integer
maxSecondsWithoutReauthentication	再認証せずに認証されたセッションが有効な状態でいられる最大期間 (秒単位)。これにより、Apache Kafka の再認証機能が有効になり、アクセストークンの有効期限が切れるとセッションが期限切れになります。最大期間の前または最大期間の到達時にアクセストークンが期限切れになると、クライアントは再認証する必要があります。そうでないと、サーバーは接続を切断します。デフォルトでは設定されません。アクセストークンが期限切れになっても認証されたセッションは期限切れになりません。このオプションは SASL_OAUTHBEARER 認証メカニズム (`enableOauthBearer` が `true` の場合) にのみ適用されます。
integer
tlsTrustedCertificates	OAuth サーバーへの TLS 接続の信頼済み証明書。
`CertSecretSource` array	OAuth サーバーへの TLS 接続の信頼済み証明書。
tokenEndpointUri	クライアントが clientId およびシークレットで認証されるときに SASL_PLAIN メカニズムで使用するトークンエンドポイントの URI。
string
type	`oauth` でなければなりません。
string	`oauth` でなければなりません。
userInfoEndpointUri	Introspection Endpoint がユーザー ID に使用できる情報を返さない場合に、ユーザー ID 取得のフォールバックとして使用する User Info Endpoint の URL。
string
userNameClaim	ユーザー ID の取得に使用される JWT 認証トークン、Introspection Endpoint の応答、または User Info Endpoint の応答からの要求の名前。デフォルトは `sub` です。
string
validIssuerUri	認証に使用されるトークン発行者の URI。
string	認証に使用されるトークン発行者の URI。
validTokenType	Introspection Endpoint によって返される `token_type` 属性の有効な値。デフォルト値はなく、デフォルトではチェックされません。
string

13.2.8. `GenericSecretSource` スキーマ参照

KafkaClientAuthenticationOAuth、KafkaListenerAuthenticationOAuth で使用

プロパティー	説明
key	OpenShift シークレットでシークレット値が保存されるキー。
string	OpenShift シークレットでシークレット値が保存されるキー。
secretName	シークレット値が含まれる OpenShift シークレットの名前。
string	シークレット値が含まれる OpenShift シークレットの名前。

13.2.9. `CertSecretSource` スキーマ参照

KafkaAuthorizationKeycloak、KafkaBridgeTls、KafkaClientAuthenticationOAuth、KafkaConnectTls、KafkaListenerAuthenticationOAuth、KafkaMirrorMaker2Tls、KafkaMirrorMakerTls で使用

プロパティー	説明
certificate	Secret のファイル証明書の名前。
string	Secret のファイル証明書の名前。
secretName	証明書が含まれる Secret の名前。
string	証明書が含まれる Secret の名前。

13.2.10. `GenericKafkaListenerConfiguration` スキーマ参照

GenericKafkaListener で使用

GenericKafkaListenerConfiguration スキーマプロパティーの完全リスト

Kafka リスナーの設定。

13.2.10.1. `brokerCertChainAndKey`

brokerCertChainAndKey プロパティーは、TLS による暗号化が有効になっているリスナーとのみ使用されます。独自の Kafka リスナー証明書を提供してこのプロパティーを使用できます。

TLS による暗号化が有効な loadbalancer 外部リスナーの設定例

listeners:
  #...
  - name: external
    port: 9094
    type: loadbalancer
    tls: true
    authentication:
      type: tls
    configuration:
      brokerCertChainAndKey:
        secretName: my-secret
        certificate: my-listener-certificate.crt
        key: my-listener-key.key
# ...

13.2.10.2. `externalTrafficPolicy`

externalTrafficPolicy プロパティーは、loadbalancer および nodeport リスナーと使用されます。OpenShift 外部で Kafka を公開する場合、Local または Cluster を選択できます。Local は他のノードへのホップを回避し、クライアント IP を保持しますが、Cluster はホップを回避せず、クライアント IP も保持しません。デフォルトは Cluster です。

13.2.10.3. `loadBalancerSourceRanges`

loadBalancerSourceRanges プロパティーは、loadbalancer リスナーとのみ使用されます。OpenShift 外部で Kafka を公開する場合、ラベルやアノテーションの他にソースの範囲を使用して、サービスの作成方法をカスタマイズします。

ロードバランサーリスナー向けに設定されたソース範囲の例

listeners:
  #...
  - name: external
    port: 9094
    type: loadbalancer
    tls: false
    configuration:
      externalTrafficPolicy: Local
      loadBalancerSourceRanges:
        - 10.0.0.0/8
        - 88.208.76.87/32
      # ...
# ...

13.2.10.4. `class`

class プロパティーは、ingress リスナーとのみ使用されます。class プロパティーを使用して Ingress クラスを設定できます。

Ingress クラスの nginx-internal を使用するタイプ ingress の外部リスナーの例

listeners:
  #...
  - name: external
    port: 9094
    type: ingress
    tls: true
    configuration:
      class: nginx-internal
    # ...
# ...

13.2.10.5. `preferredNodePortAddressType`

preferredNodePortAddressType プロパティーは、nodeport リスナーとのみ使用されます。

リスナー設定の preferredNodePortAddressType プロパティーを使用して、ノードアドレスとしてチェックされた最初のアドレスタイプを指定できます。たとえば、デプロイメントに DNS サポートがない場合や、内部 DNS または IP アドレスを介してブローカーを内部でのみ公開する場合、このプロパティーは便利です。該当タイプのアドレスが見つかった場合はそのアドレスが使用されます。アドレスタイプが見つからなかった場合、AMQ Streams は標準の優先順位でタイプの検索を続行します。

ExternalDNS
ExternalIP
Hostname
InternalDNS
InternalIP

優先ノードポートアドレスタイプで設定された外部リスナーの例

listeners:
  #...
  - name: external
    port: 9094
    type: nodeport
    tls: false
    configuration:
      preferredNodePortAddressType: InternalDNS
      # ...
# ...

13.2.10.6. `useServiceDnsDomain`

useServiceDnsDomain プロパティーは、internal リスナーとのみ使用されます。クラスターサービスサフィックス (通常は .cluster.local) を含む完全修飾 DNS 名が使用されるかどうかを定義します。useServiceDnsDomain を false に設定すると、サービスサフィックスのないアドバタイズされたアドレスが生成されます (例my-cluster-kafka-0.my-cluster-kafka-brokers.myproject.svc)。useServiceDnsDomain を true に設定すると、サービスサフィックスのあるアドバタイズされたアドレスが生成されます (例my-cluster-kafka-0.my-cluster-kafka-brokers.myproject.svc.cluster.local)。デフォルトは false です。

サービス DNS ドメインを使用するよう設定された内部リスナーの例

listeners:
  #...
  - name: plain
    port: 9092
    type: internal
    tls: false
    configuration:
      useServiceDnsDomain: true
      # ...
# ...

OpenShift クラスターが .cluster.local 以外のサービスサフィックスを使用する場合、Cluster Operator 設定で KUBERNETES_SERVICE_DNS_DOMAIN 環境変数を使用してサフィックスを設定できます。詳細は「Cluster Operator の設定」を参照してください。

13.2.10.7. `GenericKafkaListenerConfiguration` スキーマプロパティー

プロパティー	説明
brokerCertChainAndKey	このリスナーに使用される証明書と秘密鍵のペアを保持する `Secret` への参照。証明書には、任意でチェーン全体を含めることができます。このフィールドは、TLS による暗号化が有効なリスナーでのみ使用できます。
`CertAndKeySecretSource`
externalTrafficPolicy	サービスによって外部トラフィックがローカルノードのエンドポイントまたはクラスター全体のエンドポイントにルーティングされるかどうかを指定します。`Cluster` を指定すると、別のノードへの 2 回目のホップが発生し、クライアントソースの IP が特定しにくくなる可能性があります。`Local` を指定すると、LoadBalancer および Nodeport タイプのサービスに対して 2 回目のホップが発生しないようにし、クライアントソースの IP を維持します (インフラストラクチャーでサポートされる場合)。指定のない場合、OpenShift は `Cluster` をデフォルトとして使用します。このフィールドは、`loadbalancer` または `nodeport` タイプリスナーとのみ使用できます。
string ([Local、Cluster] のいずれか)
loadBalancerSourceRanges	クライアントがロードバランサータイプのリスナーに接続できる CIDR 形式による範囲 (例: `10.0.0.0/8`、`130.211.204.1/32`) の一覧。プラットフォームでサポートされる場合、ロードバランサー経由のトラフィックは指定された CIDR 範囲に制限されます。このフィールドは、ロードバランサータイプのサービスのみに適用され、クラウドプロバイダーがこの機能をサポートしない場合は無視されます。詳細は「https://v1-17.docs.kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/」を参照してください。このフィールドは、`loadbalancer` タイプリスナーとのみ使用できます。
string array
bootstrap	ブートストラップの設定。
`GenericKafkaListenerConfigurationBootstrap`	ブートストラップの設定。
brokers	ブローカーごとの設定。
`GenericKafkaListenerConfigurationBroker` 配列	ブローカーごとの設定。
class	使用される `Ingress` コントローラーを定義する `Ingress` クラスを設定します。このフィールドは、`ingress` タイプリスナーとのみ使用できます。指定されていない場合、デフォルトの Ingress コントローラーが使用されます。
string
preferredNodePortAddressType	ノードアドレスとして使用するアドレスタイプを定義します。利用可能なタイプは、`ExternalDNS`、`ExternalIP`、`InternalDNS`、`InternalIP`、および `Hostname` です。デフォルトでは、アドレスは以下の順序で使用されます (最初に見つかったアドレスが使用されます): * `ExternalDNS` * `ExternalIP` * `InternalDNS` * `InternalIP` * `Hostname` このフィールドは、優先タイプとして使用され、最初にチェックされるアドレスタイプの選択に使用できます。このアドレスタイプのアドレスが見つからない場合は、デフォルトの順序で他のタイプが使用されます。このフィールドは、`nodeport` タイプリスナーとのみ使用できます。
string ([ExternalDNS、ExternalIP、Hostname、InternalIP、InternalDNS] のいずれか)
useServiceDnsDomain	OpenShift サービス DNS ドメインを使用するべきかどうかを設定します。`true`に設定すると、生成されたアドレスにサービスの DNS ドメインサフィックスが含まれます (デフォルトでは `.cluster.local` で、`KUBERNETES_SERVICE_DNS_DOMAIN` 環境変数を使用して設定できます)。デフォルトは `false` です。このフィールドは、`internal` タイプリスナーとのみ使用できます。
boolean

13.2.11. `CertAndKeySecretSource` スキーマ参照

GenericKafkaListenerConfiguration、IngressListenerConfiguration、KafkaClientAuthenticationTls、KafkaListenerExternalConfiguration、NodePortListenerConfiguration、TlsListenerConfiguration で使用

プロパティー	説明
certificate	Secret のファイル証明書の名前。
string	Secret のファイル証明書の名前。
key	Secret の秘密鍵の名前。
string	Secret の秘密鍵の名前。
secretName	証明書が含まれる Secret の名前。
string	証明書が含まれる Secret の名前。

13.2.12. `GenericKafkaListenerConfigurationBootstrap` スキーマ参照

GenericKafkaListenerConfiguration で使用

GenericKafkaListenerConfigurationBootstrap スキーマプロパティーの完全リスト

nodePort、host、loadBalancerIP、および annotations プロパティーに相当するブローカーサービスは、GenericKafkaListenerConfigurationBroker スキーマで設定されます。

13.2.12.1. `alternativeNames`

ブートストラップサービスの代替名を指定できます。名前はブローカー証明書に追加され、TLS ホスト名の検証に使用できます。alternativeNames プロパティーは、すべてのタイプのリスナーに適用できます。

追加のブートストラップアドレスが設定された外部 route リスナーの例

listeners:
  #...
  - name: external
    port: 9094
    type: route
    tls: true
    authentication:
      type: tls
    configuration:
      bootstrap:
        alternativeNames:
          - example.hostname1
          - example.hostname2
# ...

13.2.12.2. `host`

host プロパティーは、ブートストラップおよびブローカーごとのサービスによって使用されるホスト名を指定するために route および ingress リスナーと使用されます。

Ingress コントローラーはホスト名を自動的に割り当てないため、ingress リスナー設定に host プロパティーの値は必須となります。確実にホスト名が Ingress エンドポイントに解決されるようにしてください。AMQ Streams では、要求されたホストが利用可能で、適切に Ingress エンドポイントにルーティングされることを検証しません。

Ingress リスナーのホスト設定例

listeners:
  #...
  - name: external
    port: 9094
    type: ingress
    tls: true
    authentication:
      type: tls
    configuration:
      bootstrap:
        host: bootstrap.myingress.com
      brokers:
      - broker: 0
        host: broker-0.myingress.com
      - broker: 1
        host: broker-1.myingress.com
      - broker: 2
        host: broker-2.myingress.com
# ...

デフォルトでは、route リスナーホストは OpenShift によって自動的に割り当てられます。ただし、ホストを指定して、割り当てられたルートをオーバーライドすることができます。

AMQ Streams では、要求されたホストが利用可能であることを検証しません。ホストが使用可能であることを確認する必要があります。

route リスナーのホスト設定例

# ...
listeners:
  #...
  - name: external
    port: 9094
    type: route
    tls: true
    authentication:
      type: tls
    configuration:
      bootstrap:
        host: bootstrap.myrouter.com
      brokers:
      - broker: 0
        host: broker-0.myrouter.com
      - broker: 1
        host: broker-1.myrouter.com
      - broker: 2
        host: broker-2.myrouter.com
# ...

13.2.12.3. `nodePort`

デフォルトでは、ブートストラップおよびブローカーサービスに使用されるポート番号は OpenShift によって自動的に割り当てられます。要求されたポート番号を指定すると、nodeport リスナーに割り当てられたノードポートをオーバーライドできます。

AMQ Streams は要求されたポートの検証を行いません。ポートが使用できることを確認する必要があります。

ノードポートのオーバーライドが設定された外部リスナーの例

# ...
listeners:
  #...
  - name: external
    port: 9094
    type: nodeport
    tls: true
    authentication:
      type: tls
    configuration:
      bootstrap:
        nodePort: 32100
      brokers:
      - broker: 0
        nodePort: 32000
      - broker: 1
        nodePort: 32001
      - broker: 2
        nodePort: 32002
# ...

13.2.12.4. `loadBalancerIP`

loadBalancerIP プロパティーを使用してロードバランサーの作成時に特定の IP アドレスをリクエストします。特定の IP アドレスでロードバランサーを使用する必要がある場合は、このプロパティーを使用します。クラウドプロバイダーがこの機能に対応していない場合、loadBalancerIP フィールドは無視されます。

特定のロードバランサー IP アドレスリクエストのある loadbalancer タイプの外部リスナーの例

# ...
listeners:
  #...
  - name: external
    port: 9094
    type: loadbalancer
    tls: true
    authentication:
      type: tls
    configuration:
      bootstrap:
        loadBalancerIP: 172.29.3.10
      brokers:
      - broker: 0
        loadBalancerIP: 172.29.3.1
      - broker: 1
        loadBalancerIP: 172.29.3.2
      - broker: 2
        loadBalancerIP: 172.29.3.3
# ...

13.2.12.5. `annotations`

annotations プロパティーを使用して、リスナーに関連する OpenShift リソースにアノテーションを追加します。これらのアノテーションを使用すると、自動的に DNS 名をロードバランサーサービスに割り当てる外部 DNS などの DNS ツールをインストルメント化できます。

annotations を使用するタイプ loadbalancer の外部リスナーの例

# ...
listeners:
  #...
  - name: external
    port: 9094
    type: loadbalancer
    tls: true
    authentication:
      type: tls
    configuration:
      bootstrap:
        annotations:
          external-dns.alpha.kubernetes.io/hostname: kafka-bootstrap.mydomain.com.
          external-dns.alpha.kubernetes.io/ttl: "60"
      brokers:
      - broker: 0
        annotations:
          external-dns.alpha.kubernetes.io/hostname: kafka-broker-0.mydomain.com.
          external-dns.alpha.kubernetes.io/ttl: "60"
      - broker: 1
        annotations:
          external-dns.alpha.kubernetes.io/hostname: kafka-broker-1.mydomain.com.
          external-dns.alpha.kubernetes.io/ttl: "60"
      - broker: 2
        annotations:
          external-dns.alpha.kubernetes.io/hostname: kafka-broker-2.mydomain.com.
          external-dns.alpha.kubernetes.io/ttl: "60"
# ...

13.2.12.6. `GenericKafkaListenerConfigurationBootstrap` スキーマプロパティー

プロパティー	説明
alternativeNames	ブートストラップサービスの追加の代替名。代替名は、TLS 証明書のサブジェクト代替名のリストに追加されます。
string array	ブートストラップサービスの追加の代替名。代替名は、TLS 証明書のサブジェクト代替名のリストに追加されます。
host	ブートストラップホスト。このフィールドは、ホスト名を指定するために Ingress リソースまたは Route リソースで使用されます。このフィールドは、`route` (任意) または `ingress` (必須) タイプのリスナーとのみ使用できます。
string
nodePort	ブートストラップサービスのノードポート。このフィールドは、`nodeport` タイプリスナーとのみ使用できます。
integer	ブートストラップサービスのノードポート。このフィールドは、`nodeport` タイプリスナーとのみ使用できます。
loadBalancerIP	ロードバランサーは、このフィールドに指定された IP アドレスで要求されます。この機能は、ロードバランサーの作成時に、基礎となるクラウドプロバイダーが `loadBalancerIP` の指定をサポートするかどうかによって異なります。クラウドプロバイダーがこの機能に対応していない場合、このフィールドは無視されます。このフィールドは `loadbalancer` タイプリスナーとのみ使用できます。
string
annotations	`Ingress`、`Route`、または `Service` リソースに追加されるアノテーション。このフィールドを使用して、外部 DNS などの DNS プロバイダーを設定できます。このフィールドは、`loadbalancer`、`nodeport`、`route`、または `ingress` タイプのリスナーとのみ使用できます。
map
labels	`Ingress`、`Route`、または `Service` リソースに追加されるラベル。このフィールドは、`loadbalancer`、`nodeport`、`route`、または `ingress` タイプのリスナーとのみ使用できます。
map

13.2.13. `GenericKafkaListenerConfigurationBroker` スキーマ参照

GenericKafkaListenerConfiguration で使用

GenericKafkaListenerConfigurationBroker スキーマプロパティーの完全リスト

ブートストラップサービスのオーバーライドを設定する GenericKafkaListenerConfigurationBootstrap スキーマで、nodePort、host、loadBalancerIP、および annotations プロパティーの設定例を参照できます。

ブローカーのアドバタイズされたアドレス

デフォルトでは、AMQ Streams は Kafka クラスターがそのクライアントにアドバタイズするホスト名とポートを自動的に決定しようとします。AMQ Streams が稼働しているインフラストラクチャーでは Kafka にアクセスできる正しいホスト名やポートを提供しない可能性があるため、デフォルトの動作はすべての状況に適しているわけではありません。

ブローカー ID を指定し、リスナーの configuration プロパティーでアドバタイズされたホスト名およびポートをカスタマイズできます。その後、AMQ Streams では Kafka ブローカーでアドバタイズされたアドレスが自動設定され、ブローカー証明書に追加されるため、TLS ホスト名の検証が使用できるようになります。アドバタイズされたホストおよびポートのオーバーライドは、すべてのタイプのリスナーで利用できます。

アドバタイズされたアドレスのオーバーライドが設定された外部 route リスナーの例

listeners:
  #...
  - name: external
    port: 9094
    type: route
    tls: true
    authentication:
      type: tls
    configuration:
      brokers:
      - broker: 0
        advertisedHost: example.hostname.0
        advertisedPort: 12340
      - broker: 1
        advertisedHost: example.hostname.1
        advertisedPort: 12341
      - broker: 2
        advertisedHost: example.hostname.2
        advertisedPort: 12342
# ...

13.2.13.1. `GenericKafkaListenerConfigurationBroker` スキーマプロパティー

プロパティー	説明
broker	Kafka ブローカーの ID (ブローカー識別子)。ブローカー ID は 0 から始まり、ブローカーレプリカの数に対応します。
integer
advertisedHost	ブローカーの `advertised.brokers` で使用されるホスト名。
string	ブローカーの `advertised.brokers` で使用されるホスト名。
advertisedPort	ブローカーの `advertised.brokers` で使用されるポート番号。
integer	ブローカーの `advertised.brokers` で使用されるポート番号。
host	ブローカーホスト。このフィールドは、ホスト名を指定するために Ingress リソースまたは Route リソースで使用されます。このフィールドは、`route` (任意) または `ingress` (必須) タイプのリスナーとのみ使用できます。
string
nodePort	ブローカーごとのサービスのノードポート。このフィールドは、`nodeport` タイプリスナーとのみ使用できます。
integer	ブローカーごとのサービスのノードポート。このフィールドは、`nodeport` タイプリスナーとのみ使用できます。
loadBalancerIP	ロードバランサーは、このフィールドに指定された IP アドレスで要求されます。この機能は、ロードバランサーの作成時に、基礎となるクラウドプロバイダーが `loadBalancerIP` の指定をサポートするかどうかによって異なります。クラウドプロバイダーがこの機能に対応していない場合、このフィールドは無視されます。このフィールドは `loadbalancer` タイプリスナーとのみ使用できます。
string
annotations	`Ingress` または `Service` リソースに追加されるアノテーション。このフィールドを使用して、外部 DNS などの DNS プロバイダーを設定できます。このフィールドは、`loadbalancer`、`nodeport`、または `ingress` タイプのリスナーとのみ使用できます。
map
labels	`Ingress`、`Route`、または `Service` リソースに追加されるラベル。このフィールドは、`loadbalancer`、`nodeport`、`route`、または `ingress` タイプのリスナーとのみ使用できます。
map

13.2.14. `KafkaListeners` スキーマ参照

KafkaListeners タイプは非推奨となり、API バージョン v1beta2 で削除されます。代わりに GenericKafkaListener を使用してください。

KafkaClusterSpec で使用

設定例は以前のドキュメントを参照してください。

プロパティー	説明
plain	ポート 9092 でプレーンリスナーを設定します。
`KafkaListenerPlain`	ポート 9092 でプレーンリスナーを設定します。
tls	ポート 9093 で TLS リスナーを設定します。
`KafkaListenerTls`	ポート 9093 で TLS リスナーを設定します。
external	ポート 9094 で外部リスナーを設定します。タイプは、指定のオブジェクト内の `external.type` プロパティーの値によって異なり、[route、loadbalancer、nodeport、ingress] のいずれかでなければなりません。
`KafkaListenerExternalRoute`, `KafkaListenerExternalLoadBalancer`, `KafkaListenerExternalNodePort`, `KafkaListenerExternalIngress`

13.2.15. `KafkaListenerPlain` スキーマ参照

KafkaListeners で使用

プロパティー	説明
authentication	このリスナーの認証設定。このリスナーは TLS トランスポートを使用しないため、`type: tls` で認証を設定することはできません。タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[tls、scram-sha-512、oauth] のいずれかでなければなりません。
`KafkaListenerAuthenticationTls`, `KafkaListenerAuthenticationScramSha512`, `KafkaListenerAuthenticationOAuth`
networkPolicyPeers	このリスナーに接続できるピアの一覧。この一覧のピアは、論理演算子 OR を使用して組み合わせます。このフィールドが空であるか、または存在しない場合、このリスナーのすべてのコネクションが許可されます。このフィールドが存在し、1 つ以上の項目が含まれる場合、リスナーはこの一覧の少なくとも 1 つの項目と一致するトラフィックのみを許可します。詳細は、networking.k8s.io/v1 networkpolicypeer の外部ドキュメントを参照してください。
NetworkPolicyPeer array

13.2.16. `KafkaListenerTls` スキーマ参照

KafkaListeners で使用

プロパティー	説明
authentication	このリスナーの認証設定。タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[tls、scram-sha-512、oauth] のいずれかでなければなりません。
`KafkaListenerAuthenticationTls`, `KafkaListenerAuthenticationScramSha512`, `KafkaListenerAuthenticationOAuth`
configuration	TLS リスナーの設定。
`TlsListenerConfiguration`	TLS リスナーの設定。
networkPolicyPeers	このリスナーに接続できるピアの一覧。この一覧のピアは、論理演算子 OR を使用して組み合わせます。このフィールドが空であるか、または存在しない場合、このリスナーのすべてのコネクションが許可されます。このフィールドが存在し、1 つ以上の項目が含まれる場合、リスナーはこの一覧の少なくとも 1 つの項目と一致するトラフィックのみを許可します。詳細は、networking.k8s.io/v1 networkpolicypeer の外部ドキュメントを参照してください。
NetworkPolicyPeer array

13.2.17. `TlsListenerConfiguration` スキーマ参照

KafkaListenerTls で使用

プロパティー	説明
brokerCertChainAndKey	証明書と秘密鍵のペアを保持する `Secret` への参照。証明書には、任意でチェーン全体を含めることができます。
`CertAndKeySecretSource`	証明書と秘密鍵のペアを保持する `Secret` への参照。証明書には、任意でチェーン全体を含めることができます。

13.2.18. `KafkaListenerExternalRoute` スキーマ参照

KafkaListeners で使用

type プロパティーは、KafkaListenerExternalRoute タイプの使用を KafkaListenerExternalLoadBalancer、KafkaListenerExternalNodePort、および KafkaListenerExternalIngress タイプと区別する識別子です。KafkaListenerExternalRoute タイプには route の値が必要です。

プロパティー	説明
type	`route` でなければなりません。
string	`route` でなければなりません。
authentication	Kafka ブローカーの認証の設定タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[tls、scram-sha-512、oauth] のいずれかでなければなりません。
`KafkaListenerAuthenticationTls`, `KafkaListenerAuthenticationScramSha512`, `KafkaListenerAuthenticationOAuth`
overrides	外部ブートストラップサービスおよびブローカーサービス、ならびに外部にアドバタイズされたアドレスの上書き。
`RouteListenerOverride`	外部ブートストラップサービスおよびブローカーサービス、ならびに外部にアドバタイズされたアドレスの上書き。
configuration	外部リスナーの設定。
`KafkaListenerExternalConfiguration`	外部リスナーの設定。
networkPolicyPeers	このリスナーに接続できるピアの一覧。この一覧のピアは、論理演算子 OR を使用して組み合わせます。このフィールドが空であるか、または存在しない場合、このリスナーのすべてのコネクションが許可されます。このフィールドが存在し、1 つ以上の項目が含まれる場合、リスナーはこの一覧の少なくとも 1 つの項目と一致するトラフィックのみを許可します。詳細は、networking.k8s.io/v1 networkpolicypeer の外部ドキュメントを参照してください。
NetworkPolicyPeer array

13.2.19. `RouteListenerOverride` スキーマ参照

KafkaListenerExternalRoute で使用

プロパティー	説明
bootstrap	外部ブートストラップサービスの設定。
`RouteListenerBootstrapOverride`	外部ブートストラップサービスの設定。
brokers	外部ブローカーサービスの設定。
`RouteListenerBrokerOverride` array	外部ブローカーサービスの設定。

13.2.20. `RouteListenerBootstrapOverride` スキーマ参照

RouteListenerOverride で使用

プロパティー	説明
address	ブートストラップサービスの追加のアドレス名。このアドレスは、TLS 証明書のサブジェクトの別名の一覧に追加されます。
string	ブートストラップサービスの追加のアドレス名。このアドレスは、TLS 証明書のサブジェクトの別名の一覧に追加されます。
host	ブートストラップルートのホスト。このフィールドは OpenShift Route の `spec.host` フィールドで使用されます。
string

13.2.21. `RouteListenerBrokerOverride` スキーマ参照

RouteListenerOverride で使用

プロパティー	説明
broker	Kafka ブローカーの ID (ブローカー ID)。
integer	Kafka ブローカーの ID (ブローカー ID)。
advertisedHost	ブローカーの `advertised.brokers` で使用されるホスト名。
string	ブローカーの `advertised.brokers` で使用されるホスト名。
advertisedPort	ブローカーの `advertised.brokers` で使用されるポート番号。
integer	ブローカーの `advertised.brokers` で使用されるポート番号。
host	ブローカールートのホスト。このフィールドは OpenShift Route の `spec.host` フィールドで使用されます。
string

13.2.22. `KafkaListenerExternalConfiguration` スキーマ参照

KafkaListenerExternalLoadBalancer、KafkaListenerExternalRoute で使用

プロパティー	説明
brokerCertChainAndKey	証明書と秘密鍵のペアを保持する `Secret` への参照。証明書には、任意でチェーン全体を含めることができます。
`CertAndKeySecretSource`	証明書と秘密鍵のペアを保持する `Secret` への参照。証明書には、任意でチェーン全体を含めることができます。

13.2.23. `KafkaListenerExternalLoadBalancer` スキーマ参照

KafkaListeners で使用

type プロパティーは、KafkaListenerExternalLoadBalancer タイプの使用を KafkaListenerExternalRoute、KafkaListenerExternalNodePort、および KafkaListenerExternalIngress タイプと区別する識別子です。KafkaListenerExternalLoadBalancer タイプには loadbalancer の値が必要です。

プロパティー	説明
type	`loadbalancer` でなければなりません。
string	`loadbalancer` でなければなりません。
authentication	Kafka ブローカーの認証の設定タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[tls、scram-sha-512、oauth] のいずれかでなければなりません。
`KafkaListenerAuthenticationTls`, `KafkaListenerAuthenticationScramSha512`, `KafkaListenerAuthenticationOAuth`
overrides	外部ブートストラップサービスおよびブローカーサービス、ならびに外部にアドバタイズされたアドレスの上書き。
`LoadBalancerListenerOverride`	外部ブートストラップサービスおよびブローカーサービス、ならびに外部にアドバタイズされたアドレスの上書き。
configuration	外部リスナーの設定。
`KafkaListenerExternalConfiguration`	外部リスナーの設定。
networkPolicyPeers	このリスナーに接続できるピアの一覧。この一覧のピアは、論理演算子 OR を使用して組み合わせます。このフィールドが空であるか、または存在しない場合、このリスナーのすべてのコネクションが許可されます。このフィールドが存在し、1 つ以上の項目が含まれる場合、リスナーはこの一覧の少なくとも 1 つの項目と一致するトラフィックのみを許可します。詳細は、networking.k8s.io/v1 networkpolicypeer の外部ドキュメントを参照してください。
NetworkPolicyPeer array
tls	リスナーで TLS による暗号化を有効にします。有効な TLS 暗号化の場合、デフォルトで `true` に設定されます。
boolean

13.2.24. `LoadBalancerListenerOverride` スキーマ参照

KafkaListenerExternalLoadBalancer で使用

プロパティー	説明
bootstrap	外部ブートストラップサービスの設定。
`LoadBalancerListenerBootstrapOverride`	外部ブートストラップサービスの設定。
brokers	外部ブローカーサービスの設定。
`LoadBalancerListenerBrokerOverride` array	外部ブローカーサービスの設定。

13.2.25. `LoadBalancerListenerBootstrapOverride` スキーマ参照

LoadBalancerListenerOverride で使用

プロパティー	説明
address	ブートストラップサービスの追加のアドレス名。このアドレスは、TLS 証明書のサブジェクトの別名の一覧に追加されます。
string	ブートストラップサービスの追加のアドレス名。このアドレスは、TLS 証明書のサブジェクトの別名の一覧に追加されます。
dnsAnnotations	`Service` リソースに追加されるアノテーション。このフィールドを使用して、外部 DNS などの DNS プロバイダーを設定できます。
map
loadBalancerIP	ロードバランサーは、このフィールドに指定された IP アドレスで要求されます。この機能は、ロードバランサーの作成時に、基礎となるクラウドプロバイダーが `loadBalancerIP` の指定をサポートするかどうかによって異なります。クラウドプロバイダーがこの機能に対応していない場合、このフィールドは無視されます。
string

13.2.26. `LoadBalancerListenerBrokerOverride` スキーマ参照

LoadBalancerListenerOverride で使用

プロパティー	説明
broker	Kafka ブローカーの ID (ブローカー ID)。
integer	Kafka ブローカーの ID (ブローカー ID)。
advertisedHost	ブローカーの `advertised.brokers` で使用されるホスト名。
string	ブローカーの `advertised.brokers` で使用されるホスト名。
advertisedPort	ブローカーの `advertised.brokers` で使用されるポート番号。
integer	ブローカーの `advertised.brokers` で使用されるポート番号。
dnsAnnotations	個別のブローカーの `Service` リソースに追加されるアノテーション。このフィールドを使用して、外部 DNS などの DNS プロバイダーを設定できます。
map
loadBalancerIP	ロードバランサーは、このフィールドに指定された IP アドレスで要求されます。この機能は、ロードバランサーの作成時に、基礎となるクラウドプロバイダーが `loadBalancerIP` の指定をサポートするかどうかによって異なります。クラウドプロバイダーがこの機能に対応していない場合、このフィールドは無視されます。
string

13.2.27. `KafkaListenerExternalNodePort` スキーマ参照

KafkaListeners で使用

type プロパティーは、KafkaListenerExternalNodePort タイプの使用を KafkaListenerExternalRoute、KafkaListenerExternalLoadBalancer、および KafkaListenerExternalIngress タイプと区別する識別子です。KafkaListenerExternalNodePort タイプには nodeport の値が必要です。

プロパティー	説明
type	`nodeport` でなければなりません。
string	`nodeport` でなければなりません。
authentication	Kafka ブローカーの認証の設定タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[tls、scram-sha-512、oauth] のいずれかでなければなりません。
`KafkaListenerAuthenticationTls`, `KafkaListenerAuthenticationScramSha512`, `KafkaListenerAuthenticationOAuth`
overrides	外部ブートストラップサービスおよびブローカーサービス、ならびに外部にアドバタイズされたアドレスの上書き。
`NodePortListenerOverride`	外部ブートストラップサービスおよびブローカーサービス、ならびに外部にアドバタイズされたアドレスの上書き。
configuration	外部リスナーの設定。
`NodePortListenerConfiguration`	外部リスナーの設定。
networkPolicyPeers	このリスナーに接続できるピアの一覧。この一覧のピアは、論理演算子 OR を使用して組み合わせます。このフィールドが空であるか、または存在しない場合、このリスナーのすべてのコネクションが許可されます。このフィールドが存在し、1 つ以上の項目が含まれる場合、リスナーはこの一覧の少なくとも 1 つの項目と一致するトラフィックのみを許可します。詳細は、networking.k8s.io/v1 networkpolicypeer の外部ドキュメントを参照してください。
NetworkPolicyPeer array
tls	リスナーで TLS による暗号化を有効にします。有効な TLS 暗号化の場合、デフォルトで `true` に設定されます。
boolean

13.2.28. `NodePortListenerOverride` スキーマ参照

KafkaListenerExternalNodePort で使用

プロパティー	説明
bootstrap	外部ブートストラップサービスの設定。
`NodePortListenerBootstrapOverride`	外部ブートストラップサービスの設定。
brokers	外部ブローカーサービスの設定。
`NodePortListenerBrokerOverride` array	外部ブローカーサービスの設定。

13.2.29. `NodePortListenerBootstrapOverride` スキーマ参照

NodePortListenerOverride で使用

プロパティー	説明
address	ブートストラップサービスの追加のアドレス名。このアドレスは、TLS 証明書のサブジェクトの別名の一覧に追加されます。
string	ブートストラップサービスの追加のアドレス名。このアドレスは、TLS 証明書のサブジェクトの別名の一覧に追加されます。
dnsAnnotations	`Service` リソースに追加されるアノテーション。このフィールドを使用して、外部 DNS などの DNS プロバイダーを設定できます。
map
nodePort	ブートストラップサービスのノードポート。
integer	ブートストラップサービスのノードポート。

13.2.30. `NodePortListenerBrokerOverride` スキーマ参照

NodePortListenerOverride で使用

プロパティー	説明
broker	Kafka ブローカーの ID (ブローカー ID)。
integer	Kafka ブローカーの ID (ブローカー ID)。
advertisedHost	ブローカーの `advertised.brokers` で使用されるホスト名。
string	ブローカーの `advertised.brokers` で使用されるホスト名。
advertisedPort	ブローカーの `advertised.brokers` で使用されるポート番号。
integer	ブローカーの `advertised.brokers` で使用されるポート番号。
nodePort	ブローカーサービスのノードポート。
integer	ブローカーサービスのノードポート。
dnsAnnotations	個別のブローカーの `Service` リソースに追加されるアノテーション。このフィールドを使用して、外部 DNS などの DNS プロバイダーを設定できます。
map

13.2.31. `NodePortListenerConfiguration` スキーマ参照

KafkaListenerExternalNodePort で使用

プロパティー	説明
brokerCertChainAndKey	証明書と秘密鍵のペアを保持する `Secret` への参照。証明書には、任意でチェーン全体を含めることができます。
`CertAndKeySecretSource`	証明書と秘密鍵のペアを保持する `Secret` への参照。証明書には、任意でチェーン全体を含めることができます。
preferredAddressType	ノードアドレスとして使用するアドレスタイプを定義します。利用可能なタイプは、`ExternalDNS`、`ExternalIP`、`InternalDNS`、`InternalIP`、および `Hostname` です。デフォルトでは、アドレスは以下の順序で使用されます (最初に見つかったアドレスが使用されます): * `ExternalDNS` * `ExternalIP` * `InternalDNS` * `InternalIP` * `Hostname` このフィールドは、優先タイプとして使用され、最初にチェックされるアドレスタイプの選択に使用できます。このアドレスタイプのアドレスが見つからない場合は、デフォルトの順序で他のタイプが使用されます。
string ([ExternalDNS、ExternalIP、Hostname、InternalIP、InternalDNS] のいずれか)

13.2.32. `KafkaListenerExternalIngress` スキーマ参照

KafkaListeners で使用

type プロパティーは、KafkaListenerExternalIngress タイプの使用を KafkaListenerExternalRoute、KafkaListenerExternalLoadBalancer、および KafkaListenerExternalNodePort タイプと区別する識別子です。KafkaListenerExternalIngress タイプには ingress の値が必要です。

プロパティー	説明
type	`ingress` でなければなりません。
string	`ingress` でなければなりません。
authentication	Kafka ブローカーの認証の設定タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[tls、scram-sha-512、oauth] のいずれかでなければなりません。
`KafkaListenerAuthenticationTls`, `KafkaListenerAuthenticationScramSha512`, `KafkaListenerAuthenticationOAuth`
class	使用される `Ingress` コントローラーを定義する `Ingress` クラスを設定します。
string	使用される `Ingress` コントローラーを定義する `Ingress` クラスを設定します。
configuration	外部リスナーの設定。
`IngressListenerConfiguration`	外部リスナーの設定。
networkPolicyPeers	このリスナーに接続できるピアの一覧。この一覧のピアは、論理演算子 OR を使用して組み合わせます。このフィールドが空であるか、または存在しない場合、このリスナーのすべてのコネクションが許可されます。このフィールドが存在し、1 つ以上の項目が含まれる場合、リスナーはこの一覧の少なくとも 1 つの項目と一致するトラフィックのみを許可します。詳細は、networking.k8s.io/v1 networkpolicypeer の外部ドキュメントを参照してください。
NetworkPolicyPeer array

13.2.33. `IngressListenerConfiguration` スキーマ参照

KafkaListenerExternalIngress で使用

プロパティー	説明
bootstrap	外部ブートストラップ Ingress の設定。
`IngressListenerBootstrapConfiguration`	外部ブートストラップ Ingress の設定。
brokers	外部ブローカー Ingress の設定。
`IngressListenerBrokerConfiguration` array	外部ブローカー Ingress の設定。
brokerCertChainAndKey	証明書と秘密鍵のペアを保持する `Secret` への参照。証明書には、任意でチェーン全体を含めることができます。
`CertAndKeySecretSource`	証明書と秘密鍵のペアを保持する `Secret` への参照。証明書には、任意でチェーン全体を含めることができます。

13.2.34. `IngressListenerBootstrapConfiguration` スキーマ参照

IngressListenerConfiguration で使用

プロパティー	説明
address	ブートストラップサービスの追加のアドレス名。このアドレスは、TLS 証明書のサブジェクトの別名の一覧に追加されます。
string	ブートストラップサービスの追加のアドレス名。このアドレスは、TLS 証明書のサブジェクトの別名の一覧に追加されます。
dnsAnnotations	`Ingress` リソースに追加されるアノテーション。このフィールドを使用して、外部 DNS などの DNS プロバイダーを設定できます。
map
host	ブートストラップルートのホスト。このフィールドは Ingress リソースで使用されます。
string	ブートストラップルートのホスト。このフィールドは Ingress リソースで使用されます。

13.2.35. `IngressListenerBrokerConfiguration` スキーマ参照

IngressListenerConfiguration で使用

プロパティー	説明
broker	Kafka ブローカーの ID (ブローカー ID)。
integer	Kafka ブローカーの ID (ブローカー ID)。
advertisedHost	ブローカーの `advertised.brokers` で使用されるホスト名。
string	ブローカーの `advertised.brokers` で使用されるホスト名。
advertisedPort	ブローカーの `advertised.brokers` で使用されるポート番号。
integer	ブローカーの `advertised.brokers` で使用されるポート番号。
host	ブローカー Ingress のホスト。このフィールドは Ingress リソースで使用されます。
string	ブローカー Ingress のホスト。このフィールドは Ingress リソースで使用されます。
dnsAnnotations	個別のブローカーの `Ingress` リソースに追加されるアノテーション。このフィールドを使用して、外部 DNS などの DNS プロバイダーを設定できます。
map

13.2.36. `EphemeralStorage` スキーマ参照

JbodStorage、KafkaClusterSpec、ZookeeperClusterSpec で使用

type プロパティーは、EphemeralStorage タイプの使用を PersistentClaimStorage と区別する識別子です。EphemeralStorage タイプには ephemeral の値が必要です。

プロパティー	説明
id	ストレージ ID 番号。これは、'jbod' タイプのストレージで定義されるストレージボリュームのみで必須です。
integer	ストレージ ID 番号。これは、'jbod' タイプのストレージで定義されるストレージボリュームのみで必須です。
sizeLimit	type=ephemeral の場合、この EmptyDir ボリュームに必要なローカルストレージの合計容量を定義します (例: 1Gi)。
string
type	`ephemeral` でなければなりません。
string	`ephemeral` でなければなりません。

13.2.37. `PersistentClaimStorage` スキーマ参照

JbodStorage、KafkaClusterSpec、ZookeeperClusterSpec で使用

type プロパティーは、PersistentClaimStorage タイプの使用を EphemeralStorage と区別する識別子です。PersistentClaimStorage タイプには persistent-claim の値が必要です。

プロパティー	説明
type	`persistent-claim` でなければなりません。
string	`persistent-claim` でなければなりません。
size	type=persistent-claim の場合、永続ボリューム要求のサイズを定義します (例: 1Gi).。type=persistent-claim の場合には必須です。
string
selector	使用する特定の永続ボリュームを指定します。このようなボリュームを選択するラベルを表す key:value ペアが含まれます。
map
deleteClaim	クラスターのアンデプロイ時に永続ボリューム要求を削除する必要があるかどうかを指定します。
boolean	クラスターのアンデプロイ時に永続ボリューム要求を削除する必要があるかどうかを指定します。
class	動的ボリュームの割り当てに使用するストレージクラス。
string	動的ボリュームの割り当てに使用するストレージクラス。
id	ストレージ ID 番号。これは、'jbod' タイプのストレージで定義されるストレージボリュームのみで必須です。
integer	ストレージ ID 番号。これは、'jbod' タイプのストレージで定義されるストレージボリュームのみで必須です。
overrides	個々のブローカーを上書きします。`overrides` フィールドでは、異なるブローカーに異なる設定を指定できます。
`PersistentClaimStorageOverride` array	個々のブローカーを上書きします。`overrides` フィールドでは、異なるブローカーに異なる設定を指定できます。

13.2.38. `PersistentClaimStorageOverride` スキーマ参照

PersistentClaimStorage で使用

プロパティー	説明
class	このブローカーの動的ボリュームの割り当てに使用するストレージクラス。
string	このブローカーの動的ボリュームの割り当てに使用するストレージクラス。
broker	Kafka ブローカーの ID (ブローカー ID)。
integer	Kafka ブローカーの ID (ブローカー ID)。

13.2.39. `JbodStorage` スキーマ参照

KafkaClusterSpec で使用

type プロパティーは、JbodStorage タイプの使用を EphemeralStorage、PersistentClaimStorage と区別する識別子です。JbodStorage タイプには jbod の値が必要です。

プロパティー	説明
type	`jbod` でなければなりません。
string	`jbod` でなければなりません。
volumes	JBOD ディスクアレイを表すストレージオブジェクトとしてのボリュームの一覧。
`EphemeralStorage`, `PersistentClaimStorage` 配列	JBOD ディスクアレイを表すストレージオブジェクトとしてのボリュームの一覧。

13.2.40. `KafkaAuthorizationSimple` スキーマ参照

KafkaClusterSpec で使用

KafkaAuthorizationSimple スキーマプロパティーの完全リスト

AMQ Streams の簡易承認では、AclAuthorizer プラグインが使用されます。これは、Apache Kafka で提供されるデフォルトのアクセス制御リスト (ACL) 承認プラグインです。ACL を使用すると、ユーザーがアクセスできるリソースを細かく定義できます。

Kafka カスタムリソースが簡易承認を使用するように設定します。authorization セクションの type プロパティーの値を simple に設定し、スーパーユーザーの一覧を設定します。

「ACLRule スキーマ参照」の説明にあるように、アクセスルールは KafkaUser に対して設定されます。

13.2.40.1. `superUsers`

スーパーユーザーとして扱われるユーザープリンシパルのリスト。このリストのユーザープリンシパルは、ACL ルールをクエリーしなくても常に許可されます。詳細は「Kafka の承認」を参照してください。

簡易承認の設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
  namespace: myproject
spec:
  kafka:
    # ...
    authorization:
      type: simple
      superUsers:
        - CN=client_1
        - user_2
        - CN=client_3
    # ...

注記

Kafka.spec.kafka の config プロパティーにある super.user 設定オプションは無視されます。この代わりに、authorization プロパティーでスーパーユーザーを指定します。詳細は「Kafka ブローカーの設定」を参照してください。

13.2.40.2. `KafkaAuthorizationSimple` スキーマプロパティー

type プロパティーは、KafkaAuthorizationSimple タイプの使用を KafkaAuthorizationOpa、KafkaAuthorizationKeycloak と区別する識別子です。KafkaAuthorizationSimple タイプには simple の値が必要です。

プロパティー	説明
type	`simple` でなければなりません。
string	`simple` でなければなりません。
superUsers	スーパーユーザーの一覧。無制限のアクセス権を取得する必要のあるユーザープリンシパルの一覧が含まれなければなりません。
string array	スーパーユーザーの一覧。無制限のアクセス権を取得する必要のあるユーザープリンシパルの一覧が含まれなければなりません。

13.2.41. `KafkaAuthorizationOpa` スキーマ参照

KafkaClusterSpec で使用

KafkaAuthorizationOpa スキーマプロパティーの完全リスト

Open Policy Agent 承認を使用するには、authorization セクションの type プロパティーを値 opa に設定し、必要に応じて OPA プロパティーを設定します。

13.2.41.1. `url`

Open Policy Agent サーバーへの接続に使用される URL。URL には、オーソライザーによってクエリーされるポリシーが含まれる必要があります。必須。

13.2.41.2. `allowOnError`

一時的に利用できない場合など、オーソライザーによる Open Policy Agent へのクエリーが失敗した場合に、デフォルトで Kafka クライアントを許可または拒否するかどうかを定義します。デフォルトは false で、すべてのアクションが拒否されます。

13.2.41.3. `initialCacheCapacity`

すべてのリクエストに対して Open Policy Agent をクエリーしないようにするために、オーソライザーによって使用されるローカルキャッシュの初期容量。デフォルトは 5000 です。

13.2.41.4. `maximumCacheSize`

すべてのリクエストに対して Open Policy Agent をクエリーしないようにするために、オーソライザーによって使用されるローカルキャッシュの最大容量。デフォルトは 50000 です。

13.2.41.5. `expireAfterMs`

すべてのリクエストに対して Open Policy Agent をクエリーしないようにするために、ローカルキャッシュに保持されるレコードの有効期限。キャッシュされた承認決定が Open Policy Agent サーバーからリロードされる頻度を定義します。ミリ秒単位です。デフォルトは 3600000 ミリ秒 (1 時間) です。

13.2.41.6. `superUsers`

スーパーユーザーとして扱われるユーザープリンシパルのリスト。このリストのユーザープリンシパルは、Open Policy Agent ポリシーをクエリーしなくても常に許可されます。詳細は「Kafka の承認」を参照してください。

Open Policy Agent オーソライザーの設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
  namespace: myproject
spec:
  kafka:
    # ...
    authorization:
      type: opa
      url: http://opa:8181/v1/data/kafka/allow
      allowOnError: false
      initialCacheCapacity: 1000
      maximumCacheSize: 10000
      expireAfterMs: 60000
      superUsers:
        - CN=fred
        - sam
        - CN=edward
    # ...

13.2.41.7. `KafkaAuthorizationOpa` スキーマプロパティー

type プロパティーは、KafkaAuthorizationOpa タイプの使用を KafkaAuthorizationSimple、KafkaAuthorizationKeycloak と区別する識別子です。KafkaAuthorizationOpa タイプには opa の値が必要です。

プロパティー	説明
type	`opa` でなければなりません。
string	`opa` でなければなりません。
url	Open Policy Agent サーバーへの接続に使用される URL。URL には、オーソライザーによってクエリーされるポリシーが含まれる必要があります。このオプションは必須です。
string
allowOnError	一時的に利用できない場合など、オーソライザーによる Open Policy Agent へのクエリーが失敗した場合に、デフォルトで Kafka クライアントを許可または拒否するかどうかを定義します。デフォルトは `false` で、すべてのアクションが拒否されます。
boolean
initialCacheCapacity	すべてのリクエストに対して Open Policy Agent をクエリーしないようにするために、オーソライザーによって使用されるローカルキャッシュの初期容量。デフォルトは `5000` です。
integer
maximumCacheSize	すべてのリクエストに対して Open Policy Agent をクエリーしないようにするために、オーソライザーによって使用されるローカルキャッシュの最大容量。デフォルトは `50000` です。
integer
expireAfterMs	すべてのリクエストに対して Open Policy Agent をクエリーしないようにするために、ローカルキャッシュに保持されるレコードの有効期限。キャッシュされた承認決定が Open Policy Agent サーバーからリロードされる頻度を定義します。ミリ秒単位です。デフォルトは `3600000` です。
integer
superUsers	スーパーユーザーのリスト。これは、無制限のアクセス権限を持つユーザープリンシパルのリストです。
string array	スーパーユーザーのリスト。これは、無制限のアクセス権限を持つユーザープリンシパルのリストです。

13.2.42. `KafkaAuthorizationKeycloak` スキーマ参照

KafkaClusterSpec で使用

type プロパティーは、KafkaAuthorizationKeycloak タイプの使用を KafkaAuthorizationSimple、KafkaAuthorizationOpa と区別する識別子です。KafkaAuthorizationKeycloak タイプには keycloak の値が必要です。

プロパティー	説明
type	`keycloak` でなければなりません。
string	`keycloak` でなければなりません。
clientId	Kafka クライアントが OAuth サーバーに対する認証に使用し、トークンエンドポイント URI を使用することができる OAuth クライアント ID。
string
tokenEndpointUri	承認サーバートークンエンドポイント URI。
string	承認サーバートークンエンドポイント URI。
tlsTrustedCertificates	OAuth サーバーへの TLS 接続の信頼済み証明書。
`CertSecretSource` array	OAuth サーバーへの TLS 接続の信頼済み証明書。
disableTlsHostnameVerification	TLS ホスト名の検証を有効または無効にします。デフォルト値は `false` です。
boolean	TLS ホスト名の検証を有効または無効にします。デフォルト値は `false` です。
delegateToKafkaAcls	Red Hat Single Sign-On の Authorization Services ポリシーにより DENIED となった場合に、承認の決定を 'Simple' オーソライザーに委譲すべきかどうか。デフォルト値は `false` です。
boolean
grantsRefreshPeriodSeconds	連続する付与 (Grants) 更新実行の間隔 (秒単位)。デフォルト値は 60 です。
integer	連続する付与 (Grants) 更新実行の間隔 (秒単位)。デフォルト値は 60 です。
grantsRefreshPoolSize	アクティブなセッションの付与(Grants) の更新に使用するスレッドの数。スレッドが多いほど並列処理多くなるため、ジョブがより早く完了します。ただし、使用するスレッドが多いほど、承認サーバーの負荷が大きくなります。デフォルト値は 5 です。
integer
superUsers	スーパーユーザーの一覧。無制限のアクセス権を取得する必要のあるユーザープリンシパルの一覧が含まれなければなりません。
string array	スーパーユーザーの一覧。無制限のアクセス権を取得する必要のあるユーザープリンシパルの一覧が含まれなければなりません。

13.2.43. `Rack` スキーマ参照

KafkaClusterSpec、KafkaConnectS2ISpec、KafkaConnectSpec で使用

Rack スキーマプロパティーの完全リスト

異なるラック全体でパーティションレプリカを分散するためにラックアウェアネスを設定します。

ラックは、アベイラビリティーゾーン、データセンター、またはデータセンターの実際のラックを表すことができます。Kafka クラスターの rack を設定すると、コンシューマーは最も近いレプリカからデータを取得できます。これは、Kafka クラスターが複数のデータセンターにまたがる場合に、ネットワークの負荷を軽減するのに役立ちます。

ラックアウェアネス (Rack Awareness) に Kafka ブローカーを設定するには、Kafka ブローカー Pod をノードに対してスケジュールする際に OpenShift によって使用されるクラスターノードのラベルと一致する topologyKey の値を指定します。

OpenShift クラスターがクラウドプロバイダープラットフォームで稼働している場合、ラベルはノードが稼働している可用性ゾーンを表す必要があります。通常、ノードには topologyKey の値として使用できる topology.kubernetes.io/zone ラベル (または古い OpenShift バージョンでは failure-domain.beta.kubernetes.io/zone) が付けられます。

ラックアウェアネスの設定によってブローカー Pod およびパーティションレプリカがゾーン全体に分散され、耐障害性が向上されます。また、各 Kafka ブローカーに broker.rack 設定も設定されます。broker.rack 設定によって、ラック ID が各ブローカーに割り当てられます。

ノードがデプロイされたゾーンやラックを表すノードラベルについては、OpenShift 管理者に相談します。

Kafka の rack の設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
spec:
  kafka:
    # ...
    rack:
      topologyKey: topology.kubernetes.io/zone
    config:
      # ...
      replica.selector.class: org.apache.kafka.common.replica.RackAwareReplicaSelector
    # ...

クライアントが最も近いレプリカから消費するようにするには、Kafka ReplicaSelector プラグインに RackAwareReplicaSelector 実装を使用します。ReplicaSelector プラグインは、クライアントが最も近いレプリカから消費できるようにするロジックを提供します。replica.selector.class に RackAwareReplicaSelector を指定して、デフォルト実装から切り替えます。デフォルトの実装では、LeaderSelector を使用してクライアントのリーダーレプリカを常に選択します。リーダーレプリカからレプリカフォロワーに切り替えると、遅延のコストが発生します。必要に応じて、独自の実装をカスタマイズすることもできます。

Kafka Connect を含むクライアントでは、クライアントがメッセージを消費するために使用するブローカーと同じトポロジーキーを指定します。

Kafka Connect の rack 設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaConnect
# ...
spec:
  kafka:
    # ...
    rack:
      topologyKey: topology.kubernetes.io/zone
    # ...

クライアントには client.rack ID が割り当てられます。

RackAwareReplicaSelector は、クライアントが最も近いレプリカから消費できるようにするため、broker.rack と client.rack ID の一致を関連付けます。

図13.1 同じアベイラビリティーゾーンのレプリカから消費するクライアントの例

consuming from replicas in the same availability zone

同じラックに複数のレプリカがある場合は、RackAwareReplicaSelector は常に最新のレプリカを選択します。ラック ID が指定されていない場合や、同じラック ID を持つレプリカが見つからない場合は、リーダーレプリカにフォールバックします。

OpenShift ノードラベルの詳細は、「Well-Known Labels, Annotations and Taints」を参照してください。

13.2.43.1. `Rack` スキーマプロパティー

プロパティー	説明
topologyKey	OpenShift クラスターノードに割り当てられたラベルに一致するキー。ラベルの値は、Kafka Connect でブローカーの `broker.rack` 設定と `client.rack` を設定するために使用されます。
string

13.2.44. `Probe` スキーマ参照

CruiseControlSpec、EntityTopicOperatorSpec、EntityUserOperatorSpec、KafkaBridgeSpec、KafkaClusterSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaExporterSpec、KafkaMirrorMaker2Spec、KafkaMirrorMakerSpec、TlsSidecar、TopicOperatorSpec、ZookeeperClusterSpec で使用

プロパティー	説明
failureThreshold	正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。
integer	正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。
initialDelaySeconds	最初に健全性をチェックするまでの初期の遅延。デフォルトは 15 秒です。最小値は 0 です。
integer	最初に健全性をチェックするまでの初期の遅延。デフォルトは 15 秒です。最小値は 0 です。
periodSeconds	プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。
integer	プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。
successThreshold	失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。liveness は 1 でなければなりません。最小値は 1 です。
integer
timeoutSeconds	ヘルスチェック試行のタイムアウト。デフォルトは 5 秒です。最小値は 1 です。
integer	ヘルスチェック試行のタイムアウト。デフォルトは 5 秒です。最小値は 1 です。

13.2.45. `JvmOptions` スキーマ参照

CruiseControlSpec、EntityTopicOperatorSpec、EntityUserOperatorSpec、KafkaBridgeSpec、KafkaClusterSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2Spec、KafkaMirrorMakerSpec、TopicOperatorSpec、ZookeeperClusterSpec で使用

プロパティー	説明
-XX	JVM への -XX オプションのマップ。
map	JVM への -XX オプションのマップ。
-Xms	JVM への -Xms オプション。
string	JVM への -Xms オプション。
-Xmx	JVM への -Xmx オプション。
string	JVM への -Xmx オプション。
gcLoggingEnabled	ガベージコレクションのロギングが有効かどうかを指定します。デフォルトは false です。
boolean	ガベージコレクションのロギングが有効かどうかを指定します。デフォルトは false です。
javaSystemProperties	`-D` オプションを使用して、JVM に渡される追加のシステムプロパティーのマップ。
`SystemProperty` array	`-D` オプションを使用して、JVM に渡される追加のシステムプロパティーのマップ。

13.2.46. `SystemProperty` スキーマ参照

JvmOptions で使用

プロパティー	説明
name	システムプロパティー名。
string	システムプロパティー名。
value	システムプロパティーの値。
string	システムプロパティーの値。

13.2.47. `KafkaJmxOptions` スキーマ参照

KafkaClusterSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2Spec で使用

KafkaJmxOptions スキーマプロパティーの完全リスト

JMX 接続オプションを設定します。

JMX メトリクスは、9999 で JMX ポートを開いて、Kafka ブローカー、Kafka Connect、および MirrorMaker 2.0 から取得されます。jmxOptions プロパティーを使用して、パスワードで保護される JMX ポートまたは保護されない JMX ポートを設定します。パスワードで保護すると、未許可の Pod によるポートへの不正アクセスを防ぐことができます。

その後、コンポーネントに関するメトリクスを取得できます。

たとえば、Kafka ブローカーごとに、クライアントからのバイト/秒の使用度データや、ブローカーのネットワークの要求レートを取得することができます。

JMX ポートのセキュリティーを有効にするには、authentication フィールドの type パラメーターを password に設定します。

パスワードで保護された JMX の設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
spec:
  kafka:
    # ...
    jmxOptions:
      authentication:
        type: "password"
    # ...
  zookeeper:
    # ...

次に、対応するブローカーを指定して、Pod をクラスターにデプロイし、ヘッドレスサービスを使用して JMX メトリクスを取得できます。

たとえば、ブローカー 0 から JMX メトリクスを取得するには、以下を指定します。

"CLUSTER-NAME-kafka-0.CLUSTER-NAME-kafka-brokers"

CLUSTER-NAME-kafka-0 ブローカー Pod の名前で、CLUSTER-NAME-kafka-brokers はブローカー Pod の IP を返すヘッドレスサービスの名前になります。

JMX ポートがセキュアである場合、Pod のデプロイメントで JMX Secret からユーザー名とパスワードを参照すると、そのユーザー名とパスワードを取得できます。

保護されていない JMX ポートの場合は、空のオブジェクト {} を使用してヘッドレスサービスで JMX ポートを開きます。保護されたポートと同じ方法で Pod をデプロイし、メトリクスを取得できますが、この場合はどの Pod も JMX ポートから読み取ることができます。

オープンポート JMX 設定の例

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
spec:
  kafka:
    # ...
    jmxOptions: {}
    # ...
  zookeeper:
    # ...

その他のリソース

JMX を使用して公開される Kafka コンポーネントメトリクスの詳細は、Apache Kafka のドキュメントを参照してください。

13.2.47.1. `KafkaJmxOptions` スキーマプロパティー

プロパティー	説明
authentication	JMX ポートに接続するための認証設定。タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[password] の 1 つでなければなりません。
`KafkaJmxAuthenticationPassword`

13.2.48. `KafkaJmxAuthenticationPassword` スキーマ参照

KafkaJmxOptions で使用

type プロパティーは、KafkaJmxAuthenticationPassword タイプを使用する際に、今後追加される可能性のある他のサブタイプと区別する識別子です。KafkaJmxAuthenticationPassword タイプには password の値が必要です。

プロパティー	説明
type	`password` でなければなりません。
string	`password` でなければなりません。

13.2.49. `JmxPrometheusExporterMetrics` スキーマ参照

CruiseControlSpec、KafkaClusterSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2Spec、KafkaMirrorMakerSpec、ZookeeperClusterSpec で使用

type プロパティーは、JmxPrometheusExporterMetrics タイプを使用する際に、今後追加される可能性のある他のサブタイプと区別する識別子です。JmxPrometheusExporterMetrics タイプには jmxPrometheusExporter の値が必要です。

プロパティー	説明
type	`jmxPrometheusExporter` でなければなりません。
string	`jmxPrometheusExporter` でなければなりません。
valueFrom	Prometheus JMX Exporter 設定が保存される ConfigMap エントリー。この設定の構造に関する詳細は、JMX Exporter のドキュメントを参照してください。
`ExternalConfigurationReference`

13.2.50. `ExternalConfigurationReference` スキーマ参照

ExternalLogging、JmxPrometheusExporterMetrics で使用

プロパティー	説明
configMapKeyRef	設定が含まれる ConfigMap のキーへの参照。詳細は、core/v1 configmapkeyselector の外部ドキュメントを参照してください。
ConfigMapKeySelector

13.2.51. `InlineLogging` スキーマ参照

CruiseControlSpec、EntityTopicOperatorSpec、EntityUserOperatorSpec、KafkaBridgeSpec、KafkaClusterSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2Spec、KafkaMirrorMakerSpec、TopicOperatorSpec、ZookeeperClusterSpec で使用

type プロパティーは、InlineLogging タイプの使用を ExternalLogging と区別する識別子です。InlineLogging タイプには inline の値が必要です。

プロパティー	説明
type	`inline` でなければなりません。
string	`inline` でなければなりません。
loggers	ロガー名からロガーレベルへのマップ。
map	ロガー名からロガーレベルへのマップ。

13.2.52. `ExternalLogging` スキーマ参照

CruiseControlSpec、EntityTopicOperatorSpec、EntityUserOperatorSpec、KafkaBridgeSpec、KafkaClusterSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2Spec、KafkaMirrorMakerSpec、TopicOperatorSpec、ZookeeperClusterSpec で使用

type プロパティーは、ExternalLogging タイプの使用を InlineLogging と区別する識別子です。ExternalLogging タイプには external の値が必要です。

プロパティー	説明
type	`external` でなければなりません。
string	`external` でなければなりません。
name	`name` プロパティーは非推奨となり、`valueFrom` を使用して設定する必要があります。name プロパティーは API バージョン `v1beta2` で削除されます。ロギング設定の取得元となる `ConfigMap` の名前。
string
valueFrom	ロギング設定が保存される `ConfigMap` エントリー。
`ExternalConfigurationReference`	ロギング設定が保存される `ConfigMap` エントリー。

13.2.53. `TlsSidecar` スキーマ参照

CruiseControlSpec、EntityOperatorSpec、KafkaClusterSpec、TopicOperatorSpec、ZookeeperClusterSpec で使用

TlsSidecar スキーマプロパティーの完全リスト

Pod で実行されるコンテナーである TLS サイドカーを設定しますが、サポートの目的で提供されます。。AMQ Streams では、TLS サイドカーは TLS を使用して、コンポーネントと ZooKeeper との間の通信を暗号化および復号化します。

TLS サイドカーは以下で使用されます。

Entitiy Operator
Cruise Control

TLS サイドカーは、以下で tlsSidecar プロパティーを使用して設定されます。

Kafka.spec.entityOperator
Kafka.spec.cruiseControl

TLS サイドカーは、以下の追加オプションをサポートします。

image
resources
logLevel
readinessProbe
livenessProbe

resources プロパティーは、TLS サイドカーに割り当てられるメモリーおよび CPU リソースを指定します。

image プロパティーは、使用されるコンテナーイメージを設定します。

readinessProbe および livenessProbe プロパティーは、TLS サイドカーの healthcheck プローブを設定します。

logLevel プロパティーはログレベルを指定します。以下のログレベルがサポートされます。

emerg
alert
crit
err
warning
notice
info
debug

デフォルト値は notice です。

TLS サイドカーの設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
spec:
  # ...
  entityOperator:
    # ...
    tlsSidecar:
      resources:
        requests:
          cpu: 200m
          memory: 64Mi
        limits:
          cpu: 500m
          memory: 128Mi
    # ...
  cruiseControl:
    # ...
    tlsSidecar:
      image: my-org/my-image:latest
      resources:
        requests:
          cpu: 200m
          memory: 64Mi
        limits:
          cpu: 500m
          memory: 128Mi
      logLevel: debug
      readinessProbe:
        initialDelaySeconds: 15
        timeoutSeconds: 5
      livenessProbe:
        initialDelaySeconds: 15
        timeoutSeconds: 5
    # ...

13.2.53.1. `TlsSidecar` スキーマプロパティー

プロパティー	説明
image	コンテナーの Docker イメージ。
string	コンテナーの Docker イメージ。
livenessProbe	Pod の liveness チェック。
`Probe`	Pod の liveness チェック。
logLevel	TLS サイドカーのログレベル。デフォルト値は `notice` です。
string ([emerg、debug、crit、err、alert、warning、notice、info] のいずれか)	TLS サイドカーのログレベル。デフォルト値は `notice` です。
readinessProbe	Pod の readiness チェック。
`Probe`	Pod の readiness チェック。
resources	予約する CPU およびメモリーリソース。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements

13.2.54. `KafkaClusterTemplate` スキーマ参照

KafkaClusterSpec で使用

プロパティー	説明
statefulset	Kafka `StatefulSet` のテンプレート。
`StatefulSetTemplate`	Kafka `StatefulSet` のテンプレート。
pod	Kafka `Pods` のテンプレート。
`PodTemplate`	Kafka `Pods` のテンプレート。
bootstrapService	Kafka ブートストラップ `Service` のテンプレート。
`ResourceTemplate`	Kafka ブートストラップ `Service` のテンプレート。
brokersService	Kafka ブローカー `Service` のテンプレート。
`ResourceTemplate`	Kafka ブローカー `Service` のテンプレート。
externalBootstrapService	Kafka 外部ブートストラップ `Service` のテンプレート。
`ExternalServiceTemplate`	Kafka 外部ブートストラップ `Service` のテンプレート。
perPodService	OpenShift の外部からアクセスするために使用される Kafka の Pod ごとの `Services` のテンプレート。
`ExternalServiceTemplate`
externalBootstrapRoute	Kafka 外部ブートストラップ `Route` のテンプレート。
`ResourceTemplate`	Kafka 外部ブートストラップ `Route` のテンプレート。
perPodRoute	OpenShift の外部からアクセスするために使用される Kafka の Pod ごとの `Routes` のテンプレート。
`ResourceTemplate`
externalBootstrapIngress	Kafka 外部ブートストラップ `Ingress` のテンプレート。
`ResourceTemplate`	Kafka 外部ブートストラップ `Ingress` のテンプレート。
perPodIngress	OpenShift の外部からアクセスするために使用される Kafka の Pod ごとの `Ingress` のテンプレート。
`ResourceTemplate`
persistentVolumeClaim	すべての Kafka `PersistentVolumeClaims` のテンプレート。
`ResourceTemplate`	すべての Kafka `PersistentVolumeClaims` のテンプレート。
podDisruptionBudget	Kafka `PodDisruptionBudget` のテンプレート。
`PodDisruptionBudgetTemplate`	Kafka `PodDisruptionBudget` のテンプレート。
kafkaContainer	Kafka ブローカーコンテナーのテンプレート。
`ContainerTemplate`	Kafka ブローカーコンテナーのテンプレート。
tlsSidecarContainer	`tlsSidecarContainer` プロパティーは非推奨となりました。tlsSidecarContainer プロパティーは API バージョン `v1beta2` で削除されます。Kafka ブローカー TLS サイドカーコンテナーのテンプレート。
`ContainerTemplate`
initContainer	Kafka init コンテナーのテンプレート。
`ContainerTemplate`	Kafka init コンテナーのテンプレート。
clusterCaCert	Kafka Cluster 証明書の公開鍵が含まれる Secret のテンプレート。
`ResourceTemplate`	Kafka Cluster 証明書の公開鍵が含まれる Secret のテンプレート。
clusterRoleBinding	Kafka ClusterRoleBinding のテンプレート。
`ResourceTemplate`	Kafka ClusterRoleBinding のテンプレート。

13.2.55. `StatefulSetTemplate` スキーマ参照

KafkaClusterTemplate、ZookeeperClusterTemplate で使用

プロパティー	説明
metadata	リソースに適用済みのメタデータ。
`MetadataTemplate`	リソースに適用済みのメタデータ。
podManagementPolicy	この StatefulSet に使用される PodManagementPolicy。有効な値は `Parallel` および `OrderedReady` です。デフォルトは `Parallel` です。
string ([OrderedReady、Parallel] のいずれか)

13.2.56. `MetadataTemplate` スキーマ参照

DeploymentTemplate、ExternalServiceTemplate、PodDisruptionBudgetTemplate、PodTemplate、ResourceTemplate、StatefulSetTemplate で使用

MetadataTemplate スキーマプロパティーの完全リスト

Labels および Annotations は、リソースの識別および整理に使用され、metadata プロパティーで設定されます。

以下に例を示します。

# ...
template:
  statefulset:
    metadata:
      labels:
        label1: value1
        label2: value2
      annotations:
        annotation1: value1
        annotation2: value2
# ...

labels および annotations フィールドには、予約された文字列 strimzi.io が含まれないすべてのラベルやアノテーションを含めることができます。strimzi.io が含まれるラベルやアノテーションは、内部で AMQ Streams によって使用され、設定することはできません。

13.2.56.1. `MetadataTemplate` スキーマプロパティー

プロパティー	説明
labels	リソーステンプレートに追加されたラベル。`StatefulSets`、`Deployments`、`Pods`、および `Services` などの異なるリソースに適用できます。
map
annotations	リソーステンプレートに追加されたアノテーション。`StatefulSets`、`Deployments`、`Pods`、および `Services` などの異なるリソースに適用できます。
map

13.2.57. `PodTemplate` スキーマ参照

CruiseControlTemplate、EntityOperatorTemplate、KafkaBridgeTemplate、KafkaClusterTemplate、KafkaConnectTemplate、KafkaExporterTemplate、KafkaMirrorMakerTemplate、ZookeeperClusterTemplate で使用

PodTemplate スキーマプロパティーの完全リスト

Kafka Pod のテンプレートを設定します。

PodTemplate の設定例

# ...
template:
  pod:
    metadata:
      labels:
        label1: value1
      annotations:
        anno1: value1
    imagePullSecrets:
      - name: my-docker-credentials
    securityContext:
      runAsUser: 1000001
      fsGroup: 0
    terminationGracePeriodSeconds: 120
# ...

13.2.57.1. `hostAliases`

hostAliases プロパティーを使用して、Pod の /etc/hosts ファイルに注入されるホストおよび IP アドレスの一覧を指定します。

この設定は特に、クラスター外部の接続がユーザーによっても要求される場合に Kafka Connect または MirrorMaker で役立ちます。

hostAliases の設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaConnect
#...
spec:
  # ...
  template:
    pod:
      hostAliases:
      - ip: "192.168.1.86"
        hostnames:
        - "my-host-1"
        - "my-host-2"
      #...

13.2.57.2. `PodTemplate` スキーマプロパティー

プロパティー	説明
metadata	リソースに適用済みのメタデータ。
`MetadataTemplate`	リソースに適用済みのメタデータ。
imagePullSecrets	この Pod で使用されるイメージのプルに使用する同じ namespace のシークレットへの参照の一覧です。Cluster Operator の `STRIMZI_IMAGE_PULL_SECRETS` 環境変数と `imagePullSecrets` オプションが指定されると、`imagePullSecrets` 変数のみが使用され、`STRIMZI_IMAGE_PULL_SECRETS` 変数は無視されます。詳細は、core/v1 localobjectreference の外部ドキュメントを参照してください。
LocalObjectReference array
securityContext	Pod レベルのセキュリティー属性と共通のコンテナー設定を設定します。詳細は、core/v1 podsecuritycontext の外部ドキュメントを参照してください。
PodSecurityContext
terminationGracePeriodSeconds	猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。値は負の値ではない整数にする必要があります。値をゼロにすると、即座に削除されます。非常に大型な Kafka クラスターの場合は、正常終了期間を延長し、Kafka ブローカーの終了前に作業を別のブローカーに転送する時間を十分確保する必要があることがあります。デフォルトは 30 秒です。
integer
affinity	Pod のアフィニティールール。詳細は、core/v1 affinity の外部ドキュメントを参照してください。
Affinity	Pod のアフィニティールール。詳細は、core/v1 affinity の外部ドキュメントを参照してください。
tolerations	Pod の許容 (Toleration)。詳細は、core/v1 toleration の外部ドキュメントを参照してください。
Toleration array
priorityClassName	優先順位を Pod に割り当てるために使用される優先順位クラス (Priority Class) の名前。Priority Class (優先順位クラス) の詳細は、「Pod Priority and Preemption」を参照してください。
string
schedulerName	この `Pod` のディスパッチに使用されるスケジューラーの名前。指定されていない場合、デフォルトのスケジューラーが使用されます。
string
hostAliases	Pod の HostAliases。HostAliases は、指定された場合に Pod の hosts ファイルに注入されるホストおよび IP のオプションのリストです。詳細は、core/v1 HostAlias の外部ドキュメントを参照してください。
HostAlias array
topologySpreadConstraints	Pod のトポロジー分散制約。詳細は、core/v1 topologyspreadconstraint の外部ドキュメントを参照してください。
TopologySpreadConstraint array

13.2.58. `ResourceTemplate` スキーマ参照

CruiseControlTemplate、EntityOperatorTemplate、KafkaBridgeTemplate、KafkaClusterTemplate、KafkaConnectTemplate、KafkaExporterTemplate、KafkaUserTemplate、ZookeeperClusterTemplate で使用

プロパティー	説明
metadata	リソースに適用済みのメタデータ。
`MetadataTemplate`	リソースに適用済みのメタデータ。

13.2.59. `ExternalServiceTemplate` スキーマ参照

KafkaClusterTemplate で使用

ExternalServiceTemplate スキーマプロパティーの完全リスト

ロードバランサーまたはノードポートを使用して OpenShift 外部で Kafka を公開する場合、ラベルとアノテーションの他にプロパティーを使用してサービスの作成をカスタマイズできます。

カスタマイズした外部サービスの例

# ...
template:
  externalBootstrapService:
    externalTrafficPolicy: Local
    loadBalancerSourceRanges:
      - 10.0.0.0/8
      - 88.208.76.87/32
  perPodService:
    externalTrafficPolicy: Local
    loadBalancerSourceRanges:
      - 10.0.0.0/8
      - 88.208.76.87/32
# ...

13.2.59.1. `ExternalServiceTemplate` スキーマプロパティー

プロパティー	説明
metadata	リソースに適用済みのメタデータ。
`MetadataTemplate`	リソースに適用済みのメタデータ。
externalTrafficPolicy	`externalTrafficPolicy` プロパティーは非推奨となり、`spec.kafka.listeners[].configuration` を使用して設定する必要があります。externalTrafficPolicy プロパティーは API バージョン `v1beta2` で削除されます。サービスによって外部トラフィックがローカルノードのエンドポイントまたはクラスター全体のエンドポイントにルーティングされるかどうかを指定します。`Cluster` を指定すると、別のノードへの 2 回目のホップが発生し、クライアントソースの IP が特定しにくくなる可能性があります。`Local` を指定すると、LoadBalancer および Nodeport タイプのサービスに対して 2 回目のホップが発生しないようにし、クライアントソースの IP を維持します (インフラストラクチャーでサポートされる場合)。指定されていない場合、OpenShift は `Cluster` をデフォルトとして使用します。
string ([Local、Cluster] のいずれか)
loadBalancerSourceRanges	`loadBalancerSourceRanges` プロパティーは非推奨となり、`spec.kafka.listeners[].configuration` を使用して設定する必要があります。loadBalancerSourceRanges プロパティーは API バージョン `v1beta2` で削除されます。クライアントがロードバランサータイプのリスナーに接続できる CIDR 形式による範囲 (例: `10.0.0.0/8`、`130.211.204.1/32`) の一覧。プラットフォームでサポートされる場合、ロードバランサー経由のトラフィックは指定された CIDR 範囲に制限されます。このフィールドは、ロードバランサータイプのサービスのみに適用され、クラウドプロバイダーがこの機能をサポートしない場合は無視されます。詳細は「https://v1-17.docs.kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/」を参照してください。
string array

13.2.60. `PodDisruptionBudgetTemplate` スキーマ参照

CruiseControlTemplate、KafkaBridgeTemplate、KafkaClusterTemplate、KafkaConnectTemplate、KafkaMirrorMakerTemplate、ZookeeperClusterTemplate で使用

PodDisruptionBudgetTemplate スキーマプロパティーの完全リスト

AMQ Streams は、新しい StatefulSet または Deployment ごとに PodDisruptionBudget を作成します。デフォルトでは、Pod の Disruption Budget (停止状態の予算) は単一の Pod を指定時に利用不可能にすることのみ許可します。PodDisruptionBudget.spec リソースの maxUnavailable プロパティーのデフォルト値を変更することで、許容される利用不可能な Pod の数を増やすことができます。

PodDisruptionBudget テンプレートの例

# ...
template:
    podDisruptionBudget:
        metadata:
            labels:
                key1: label1
                key2: label2
            annotations:
                key1: label1
                key2: label2
        maxUnavailable: 1
# ...

13.2.60.1. `PodDisruptionBudgetTemplate` スキーマプロパティー

プロパティー	説明
metadata	`PodDistruptionBugetTemplate` リソースに適用するメタデータ。
`MetadataTemplate`	`PodDistruptionBugetTemplate` リソースに適用するメタデータ。
maxUnavailable	自動 Pod エビクションを許可するための利用不可能な Pod の最大数。Pod エビクションは、`maxUnavailable` の Pod 数またはそれより少ない Pod 数がエビクション後に利用できない場合に許可されます。この値を 0 に設定するとすべての自発的なエビクションを阻止するため、Pod を手動でエビクトする必要があります。デフォルトは 1 です。
integer

13.2.61. `ContainerTemplate` スキーマ参照

ContainerTemplate スキーマプロパティーの完全リスト

コンテナーのカスタムのセキュリティーコンテキストおよび環境変数を設定できます。

環境変数は、env プロパティーで name および value フィールドのあるオブジェクトのリストとして定義されます。以下の例は、Kafka ブローカーコンテナーに設定された 2 つのカスタム環境変数と 1 つのセキュリティーコンテキストを示しています。

# ...
template:
  kafkaContainer:
    env:
    - name: EXAMPLE_ENV_1
      value: example.env.one
    - name: EXAMPLE_ENV_2
      value: example.env.two
    securityContext:
      runAsUser: 2000
# ...

KAFKA_ で始まる環境変数は AMQ Streams 内部となるため、使用しないようにしてください。AMQ Streams によってすでに使用されているカスタム環境変数を設定すると、その環境変数は無視され、警告がログに記録されます。

13.2.61.1. `ContainerTemplate` スキーマプロパティー

プロパティー	説明
env	コンテナーに適用する必要のある環境変数。
`ContainerEnvVar` array	コンテナーに適用する必要のある環境変数。
securityContext	コンテナーのセキュリティーコンテキスト。詳細は、core/v1 securitycontext の外部ドキュメントを参照してください。
SecurityContext

13.2.62. `ContainerEnvVar` スキーマ参照

ContainerTemplate で使用

プロパティー	説明
name	環境変数のキー。
string	環境変数のキー。
value	環境変数の値。
string	環境変数の値。

13.2.63. `ZookeeperClusterSpec` スキーマ参照

KafkaSpec で使用

ZookeeperClusterSpec スキーマプロパティーの完全リスト

ZooKeeper クラスターを設定します。

13.2.63.1. `config`

config プロパティーを使用して、ZooKeeper オプションをキーとして設定します。

標準の Apache ZooKeeper 設定が提供されることがあり、AMQ Streams によって直接管理されないプロパティーに限定されます。

以下に関連する設定オプションは設定できません。

セキュリティー (暗号化、認証、および承認)
リスナーの設定
データディレクトリーの設定
ZooKeeper クラスターの構成

値は以下の JSON タイプのいずれかになります。

文字列
数値
ブール値

AMQ Streams で直接管理されるオプション以外の、ZooKeeper ドキュメントに記載されているオプションを指定および設定できます。以下の文字列の 1 つと同じキーまたは以下の文字列の 1 つで始まるキーを持つ設定オプションはすべて禁止されています。

server.
dataDir
dataLogDir
clientPort
authProvider
quorum.auth
requireClientAuthScheme

禁止されているオプションが config プロパティーにある場合、そのオプションは無視され、警告メッセージが Cluster Operator ログファイルに出力されます。サポートされるその他すべてのオプションは ZooKeeper に渡されます。

禁止されているオプションには例外があります。TLS バージョンに特定の 暗号スイート を使用するクライアント接続では、許可された ssl プロパティーを設定できます。

ZooKeeper の設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
spec:
  kafka:
    # ...
  zookeeper:
    # ...
    config:
      autopurge.snapRetainCount: 3
      autopurge.purgeInterval: 1
      ssl.cipher.suites: "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
      ssl.enabled.protocols: "TLSv1.2"
      ssl.protocol: "TLSv1.2"
    # ...

13.2.63.2. `logging`

ZooKeeper には設定可能なロガーがあります。

zookeeper.root.logger

ZooKeeper では Apache log4j ロガー実装が使用されます。

logging プロパティーを使用してロガーおよびロガーレベルを設定します。

inline および external ロギングの例は次のとおりです。

inline ロギング

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
spec:
  # ...
  zookeeper:
    # ...
    logging:
      type: inline
      loggers:
        zookeeper.root.logger: "INFO"
    # ...

外部ロギング

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
spec:
  # ...
  zookeeper:
    # ...
    logging:
      type: external
      valueFrom:
        configMapKeyRef:
          name: customConfigMap
          key: zookeeper-log4j.properties
  # ...

ガベッジコレクター (GC)

ガベッジコレクターのロギングは、jvmOptions プロパティーを使用して有効 (または無効) にすることもできます。

13.2.63.3. `ZookeeperClusterSpec` スキーマプロパティー

プロパティー	説明
replicas	クラスター内の Pod 数。
integer	クラスター内の Pod 数。
image	Pod の Docker イメージ。
string	Pod の Docker イメージ。
storage	ストレージの設定 (ディスク)。更新はできません。タイプは、指定のオブジェクト内の `storage.type` プロパティーの値によって異なり、[ephemeral、persistent-claim] のいずれかでなければなりません。
`EphemeralStorage`, `PersistentClaimStorage`
config	ZooKeeper ブローカーの設定。次の接頭辞のあるプロパティーは設定できません: server.、 dataDir、dataLogDir、clientPort、authProvider、quorum.auth、requireClientAuthScheme、 snapshot.trust.empty、standaloneEnabled、reconfigEnabled、4lw.commands.whitelist、secureClientPort、ssl、serverCnxnFactory、sslQuorum (次の例外を除く: ssl.protocol、ssl.quorum.protocol、ssl.enabledProtocols、ssl.quorum.enabledProtocols、ssl.ciphersuites、ssl.quorum.ciphersuites、ssl.hostnameVerification、ssl.quorum.hostnameVerification)
map
affinity	`affinity` プロパティーは非推奨となり、`spec.zookeeper.template.pod.affinity` を使用して設定する必要があります。affinity プロパティーは API バージョン `v1beta2` で削除されます。Pod のアフィニティールール。詳細は、core/v1 affinity の外部ドキュメントを参照してください。
Affinity
tolerations	`tolerations` プロパティーは非推奨となり、`spec.zookeeper.template.pod.tolerations` を使用して設定する必要があります。tolerations プロパティーは API バージョン `v1beta2` で削除されます。Pod の許容 (Toleration)。詳細は、core/v1 toleration の外部ドキュメントを参照してください。
Toleration array
livenessProbe	Pod の liveness チェック。
`Probe`	Pod の liveness チェック。
readinessProbe	Pod の readiness チェック。
`Probe`	Pod の readiness チェック。
jvmOptions	Pod の JVM オプション。
`JvmOptions`	Pod の JVM オプション。
resources	予約する CPU およびメモリーリソース。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements
metrics	`metrics` プロパティーは非推奨となり、`spec.zookeeper.metricsConfig` を使用して設定する必要があります。metrics プロパティーは API バージョン `v1beta2` で削除されます。Prometheus JMX エクスポーターの設定。この設定の構造に関する詳細は、https://github.com/prometheus/jmx_exporter を参照してください。
map
metricsConfig	メトリクスの設定。タイプは、指定のオブジェクト内の `metricsConfig.type` プロパティーの値によって異なり、[jmxPrometheusExporter] の 1 つでなければなりません。
`JmxPrometheusExporterMetrics`
logging	ZooKeeper のロギング設定。タイプは、指定のオブジェクト内の `logging.type` プロパティーの値によって異なり、[inline、external] のいずれかでなければなりません。
`InlineLogging`, `ExternalLogging`
template	ZooKeeper クラスターリソースのテンプレート。テンプレートを使用すると、ユーザーは `StatefulSet`、`Pods`、および `Services` の生成方法を指定できます。
`ZookeeperClusterTemplate`
tlsSidecar	`tlsSidecar` プロパティーは非推奨となりました。tlsSidecar プロパティーは API バージョン `v1beta2` で削除されます。TLS サイドカーの設定。TLS サイドカーは使用されなくなりました。このオプションは無視されます。
`TlsSidecar`

13.2.64. `ZookeeperClusterTemplate` スキーマ参照

ZookeeperClusterSpec で使用

プロパティー	説明
statefulset	ZooKeeper `StatefulSet` のテンプレート。
`StatefulSetTemplate`	ZooKeeper `StatefulSet` のテンプレート。
pod	ZooKeeper `Pods` のテンプレート。
`PodTemplate`	ZooKeeper `Pods` のテンプレート。
clientService	ZooKeeper クライアント `Service` のテンプレート。
`ResourceTemplate`	ZooKeeper クライアント `Service` のテンプレート。
nodesService	ZooKeeper ノード `Service` のテンプレート。
`ResourceTemplate`	ZooKeeper ノード `Service` のテンプレート。
persistentVolumeClaim	すべての ZooKeeper `PersistentVolumeClaims` のテンプレート。
`ResourceTemplate`	すべての ZooKeeper `PersistentVolumeClaims` のテンプレート。
podDisruptionBudget	ZooKeeper `PodDisruptionBudget` のテンプレート。
`PodDisruptionBudgetTemplate`	ZooKeeper `PodDisruptionBudget` のテンプレート。
zookeeperContainer	ZooKeeper コンテナーのテンプレート。
`ContainerTemplate`	ZooKeeper コンテナーのテンプレート。
tlsSidecarContainer	`tlsSidecarContainer` プロパティーは非推奨となりました。tlsSidecarContainer プロパティーは API バージョン `v1beta2` で削除されます。ZooKeeper サーバーの TLS サイドカーコンテナーのテンプレート。TLS サイドカーは使用されなくなりました。このオプションは無視されます。
`ContainerTemplate`

13.2.65. `TopicOperatorSpec` スキーマ参照

TopicOperatorSpec タイプは非推奨となり、API バージョン v1beta2 で削除されます。代わりに EntityTopicOperatorSpec を使用してください。

KafkaSpec で使用

プロパティー	説明
watchedNamespace	Topic Operator が監視する必要のある namespace。
string	Topic Operator が監視する必要のある namespace。
image	Topic Operator に使用するイメージ。
string	Topic Operator に使用するイメージ。
reconciliationIntervalSeconds	定期的な調整の間隔。
integer	定期的な調整の間隔。
zookeeperSessionTimeoutSeconds	ZooKeeper セッションのタイムアウト。
integer	ZooKeeper セッションのタイムアウト。
affinity	`affinity` プロパティーは非推奨となり、`spec.entityOperator.template.pod.affinity` を使用して設定する必要があります。affinity プロパティーは API バージョン `v1beta2` で削除されます。Pod のアフィニティールール。詳細は、core/v1 affinity の外部ドキュメントを参照してください。
Affinity
resources	予約する CPU およびメモリーリソース。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements
topicMetadataMaxAttempts	トピックメタデータの取得を試行する回数。
integer	トピックメタデータの取得を試行する回数。
tlsSidecar	`tlsSidecar` プロパティーは非推奨となり、`spec.entityOperator.tlsSidecar` を使用して設定する必要があります。tlsSidecar プロパティーは API バージョン `v1beta2` で削除されます。TLS サイドカーの設定。
`TlsSidecar`
logging	ロギング設定。タイプは、指定のオブジェクト内の `logging.type` プロパティーの値によって異なり、[inline、external] のいずれかでなければなりません。
`InlineLogging`, `ExternalLogging`
jvmOptions	Pod の JVM オプション。
`JvmOptions`	Pod の JVM オプション。
livenessProbe	Pod の liveness チェック。
`Probe`	Pod の liveness チェック。
readinessProbe	Pod の readiness チェック。
`Probe`	Pod の readiness チェック。
startupProbe	Pod の起動チェック。
`Probe`	Pod の起動チェック。

13.2.66. `EntityOperatorSpec` スキーマ参照

KafkaSpec で使用

プロパティー	説明
topicOperator	Topic Operator の設定。
`EntityTopicOperatorSpec`	Topic Operator の設定。
userOperator	User Operator の設定。
`EntityUserOperatorSpec`	User Operator の設定。
affinity	`affinity` プロパティーは非推奨となり、`spec.entityOperator.template.pod.affinity` を使用して設定する必要があります。affinity プロパティーは API バージョン `v1beta2` で削除されます。Pod のアフィニティールール。詳細は、core/v1 affinity の外部ドキュメントを参照してください。
Affinity
tolerations	`tolerations` プロパティーは非推奨となり、`spec.entityOperator.template.pod.tolerations` を使用して設定する必要があります。tolerations プロパティーは API バージョン `v1beta2` で削除されます。Pod の許容 (Toleration)。詳細は、core/v1 toleration の外部ドキュメントを参照してください。
Toleration array
tlsSidecar	TLS サイドカーの設定。
`TlsSidecar`	TLS サイドカーの設定。
template	Entity Operator リソースのテンプレート。テンプレートを使用すると、ユーザーは `Deployment` および `Pods` の生成方法を指定できます。
`EntityOperatorTemplate`

13.2.67. `EntityTopicOperatorSpec` スキーマ参照

EntityOperatorSpec で使用

EntityTopicOperatorSpec スキーマプロパティーの完全リスト

Topic Operator を設定します。

13.2.67.1. `logging`

Topic Operator には設定可能なロガーがあります。

rootLogger.level

Topic Operator では Apache log4j2 ロガー実装が使用されます。

Kafka リソース Kafka の entityOperator.topicOperator フィールドの logging プロパティーを使用して、ロガーおよびロガーレベルを設定します。

ログレベルを設定するには、ロガーとレベルを直接指定 (インライン) するか、またはカスタム (外部) ConfigMap を使用します。ConfigMap を使用する場合、logging.valueFrom.configMapKeyRef.name プロパティーを外部ロギング設定が含まれる ConfigMap の名前に設定します。ConfigMap 内では、ロギング設定は log4j2.properties を使用して記述されます。logging.valueFrom.configMapKeyRef.name および logging.valueFrom.configMapKeyRef.key プロパティーはいずれも必須です。Cluster Operator の実行時に、指定された正確なロギング設定を使用する ConfigMap がカスタムリソースを使用して作成され、その後は調整のたびに再作成されます。カスタム ConfigMap を指定しない場合、デフォルトのロギング設定が使用されます。特定のロガー値が設定されていない場合、上位レベルのロガー設定がそのロガーに継承されます。ログレベルの詳細は、「Apache logging services」を参照してください。

inline および external ロギングの例は次のとおりです。

inline ロギング

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
spec:
  kafka:
    # ...
  zookeeper:
    # ...
  entityOperator:
    # ...
    topicOperator:
      watchedNamespace: my-topic-namespace
      reconciliationIntervalSeconds: 60
      logging:
        type: inline
        loggers:
          rootLogger.level: INFO
  # ...

外部ロギング

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
spec:
  kafka:
    # ...
  zookeeper:
    # ...
  entityOperator:
    # ...
    topicOperator:
      watchedNamespace: my-topic-namespace
      reconciliationIntervalSeconds: 60
      logging:
        type: external
        valueFrom:
          configMapKeyRef:
            name: customConfigMap
            key: topic-operator-log4j2.properties
  # ...

ガベッジコレクター (GC)

ガベッジコレクターのロギングは、jvmOptions プロパティーを使用して有効 (または無効) にすることもできます。

13.2.67.2. `EntityTopicOperatorSpec` スキーマプロパティー

プロパティー	説明
watchedNamespace	Topic Operator が監視する必要のある namespace。
string	Topic Operator が監視する必要のある namespace。
image	Topic Operator に使用するイメージ。
string	Topic Operator に使用するイメージ。
reconciliationIntervalSeconds	定期的な調整の間隔。
integer	定期的な調整の間隔。
zookeeperSessionTimeoutSeconds	ZooKeeper セッションのタイムアウト。
integer	ZooKeeper セッションのタイムアウト。
startupProbe	Pod の起動チェック。
`Probe`	Pod の起動チェック。
livenessProbe	Pod の liveness チェック。
`Probe`	Pod の liveness チェック。
readinessProbe	Pod の readiness チェック。
`Probe`	Pod の readiness チェック。
resources	予約する CPU およびメモリーリソース。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements
topicMetadataMaxAttempts	トピックメタデータの取得を試行する回数。
integer	トピックメタデータの取得を試行する回数。
logging	ロギング設定。タイプは、指定のオブジェクト内の `logging.type` プロパティーの値によって異なり、[inline、external] のいずれかでなければなりません。
`InlineLogging`, `ExternalLogging`
jvmOptions	Pod の JVM オプション。
`JvmOptions`	Pod の JVM オプション。

13.2.68. `EntityUserOperatorSpec` スキーマ参照

EntityOperatorSpec で使用

EntityUserOperatorSpec スキーマプロパティーの完全リスト

User Operator を設定します。

13.2.68.1. `logging`

User Operator には設定可能なロガーがあります。

rootLogger.level

User Operator では Apache log4j2 ロガー実装が使用されます。

Kafka リソースの entityOperator.userOperator フィールドの logging プロパティーを使用して、ロガーおよびロガーレベルを設定します。

ログレベルを設定するには、ロガーとレベルを直接指定 (インライン) するか、またはカスタム (外部) ConfigMap を使用します。ConfigMap を使用する場合、logging.valueFrom.configMapKeyRef.name プロパティーを外部ロギング設定が含まれる ConfigMap の名前に設定します。ConfigMap 内では、ロギング設定は log4j2.properties を使用して記述されます。logging.valueFrom.configMapKeyRef.name および logging.valueFrom.configMapKeyRef.key プロパティーはいずれも必須です。Cluster Operator の実行時に、指定された正確なロギング設定を使用する ConfigMap がカスタムリソースを使用して作成され、その後は調整のたびに再作成されます。カスタム ConfigMap を指定しない場合、デフォルトのロギング設定が使用されます。特定のロガー値が設定されていない場合、上位レベルのロガー設定がそのロガーに継承されます。ログレベルの詳細は、「Apache logging services」を参照してください。

inline および external ロギングの例は次のとおりです。

inline ロギング

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
spec:
  kafka:
    # ...
  zookeeper:
    # ...
  entityOperator:
    # ...
    userOperator:
      watchedNamespace: my-topic-namespace
      reconciliationIntervalSeconds: 60
      logging:
        type: inline
        loggers:
          rootLogger.level: INFO
  # ...

外部ロギング

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
  name: my-cluster
spec:
  kafka:
    # ...
  zookeeper:
    # ...
  entityOperator:
    # ...
    userOperator:
      watchedNamespace: my-topic-namespace
      reconciliationIntervalSeconds: 60
      logging:
        type: external
        valueFrom:
          configMapKeyRef:
            name: customConfigMap
            key: user-operator-log4j2.properties
   # ...

ガベッジコレクター (GC)

ガベッジコレクターのロギングは、jvmOptions プロパティーを使用して有効 (または無効) にすることもできます。

13.2.68.2. `EntityUserOperatorSpec` スキーマプロパティー

プロパティー	説明
watchedNamespace	User Operator が監視する必要のある namespace。
string	User Operator が監視する必要のある namespace。
image	User Operator に使用するイメージ。
string	User Operator に使用するイメージ。
reconciliationIntervalSeconds	定期的な調整の間隔。
integer	定期的な調整の間隔。
zookeeperSessionTimeoutSeconds	ZooKeeper セッションのタイムアウト。
integer	ZooKeeper セッションのタイムアウト。
secretPrefix	KafkaUser 名に追加され、Secret 名として使用されるプレフィックス。
string	KafkaUser 名に追加され、Secret 名として使用されるプレフィックス。
livenessProbe	Pod の liveness チェック。
`Probe`	Pod の liveness チェック。
readinessProbe	Pod の readiness チェック。
`Probe`	Pod の readiness チェック。
resources	予約する CPU およびメモリーリソース。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements
logging	ロギング設定。タイプは、指定のオブジェクト内の `logging.type` プロパティーの値によって異なり、[inline、external] のいずれかでなければなりません。
`InlineLogging`, `ExternalLogging`
jvmOptions	Pod の JVM オプション。
`JvmOptions`	Pod の JVM オプション。

13.2.69. `EntityOperatorTemplate` スキーマ参照

EntityOperatorSpec で使用

プロパティー	説明
deployment	Entity Operator `Deployment` のテンプレート。
`ResourceTemplate`	Entity Operator `Deployment` のテンプレート。
pod	Entity Operator `Pods` のテンプレート。
`PodTemplate`	Entity Operator `Pods` のテンプレート。
tlsSidecarContainer	Entity Operator TLS サイドカーコンテナーのテンプレート。
`ContainerTemplate`	Entity Operator TLS サイドカーコンテナーのテンプレート。
topicOperatorContainer	Entity Topic Operator コンテナーのテンプレート。
`ContainerTemplate`	Entity Topic Operator コンテナーのテンプレート。
userOperatorContainer	Entity User Operator コンテナーのテンプレート。
`ContainerTemplate`	Entity User Operator コンテナーのテンプレート。

13.2.70. `CertificateAuthority` スキーマ参照

KafkaSpec で使用

TLS 証明書のクラスター内での使用方法の設定。これは、クラスター内の内部通信に使用される証明書および Kafka.spec.kafka.listeners.tls を介したクライアントアクセスに使用される証明書の両方に適用されます。

プロパティー	説明
generateCertificateAuthority	true の場合、認証局の証明書が自動的に生成されます。それ以外の場合は、ユーザーは CA 証明書で Secret を提供する必要があります。デフォルトは true です。
boolean
generateSecretOwnerReference	`true` の場合、クラスターおよびクライアント CA Secret は `Kafka` リソースに設定された `ownerReference` で設定されます。`true` の場合、`Kafka` リソースが削除されると、CA Secret も削除されます。`false` の場合、`ownerReference` は無効になります。`false` の場合、`Kafka` リソースが削除されると、CA Secret は保持され、再利用できます。デフォルトは `true` です。
boolean
validityDays	生成される証明書の有効日数。デフォルトは 365 です。
integer	生成される証明書の有効日数。デフォルトは 365 です。
renewalDays	証明書更新期間の日数。これは、証明書の期限が切れるまでの日数です。この間に、更新アクションを実行することができます。`generateCertificateAuthority` が true の場合、新しい証明書が生成されます。`generateCertificateAuthority` が true の場合、保留中の証明書の有効期限に関する追加のロギングが WARN レベルで実行されます。デフォルトは 30 です。
integer
certificateExpirationPolicy	`generateCertificateAuthority=true` の場合に CA 証明書の有効期限を処理する方法。デフォルトでは、既存の秘密鍵を再度使用して新規の CA 証明書が生成されます。
string ([replace-key、renew-certificate] のいずれか)

13.2.71. `CruiseControlSpec` スキーマ参照

KafkaSpec で使用

プロパティー	説明
image	Pod の Docker イメージ。
string	Pod の Docker イメージ。
tlsSidecar	TLS サイドカーの設定。
`TlsSidecar`	TLS サイドカーの設定。
resources	Cruise Control コンテナー用に予約された CPU およびメモリーリソース。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements
livenessProbe	Cruise Control コンテナーの Pod liveness チェック
`Probe`	Cruise Control コンテナーの Pod liveness チェック
readinessProbe	Cruise Control コンテナーの Pod readiness チェック
`Probe`	Cruise Control コンテナーの Pod readiness チェック
jvmOptions	Cruise Control コンテナーの JVM オプション
`JvmOptions`	Cruise Control コンテナーの JVM オプション
logging	Cruise Control のロギング設定 (Log4j 2)。タイプは、指定のオブジェクト内の `logging.type` プロパティーの値によって異なり、[inline、external] のいずれかでなければなりません。
`InlineLogging`, `ExternalLogging`
template	Cruise Control のリソースである `Deployments` および `Pods` の生成方法を指定するテンプレート。
`CruiseControlTemplate`
brokerCapacity	Cruise Control `brokerCapacity` の設定。
`BrokerCapacity`	Cruise Control `brokerCapacity` の設定。
config	Cruise Control の設定。設定オプションの完全リストは、https://github.com/linkedin/cruise-control/wiki/Configurations を参照してください。次のプレフィックスのあるプロパティーは設定できません: bootstrap.servers、client.id、zookeeper.、network.、security.、failed.brokers.zk.path、webserver.http.、 webserver.api.urlprefix、webserver.session.path、webserver.accesslog.、two.step.、request.reason.required、metric.reporter.sampler.bootstrap.servers、 metric.reporter.topic、partition.metric.sample.store.topic、broker.metric.sample.store.topic、capacity.config.file、self.healing.、anomaly.detection.、ssl (例外は ssl.cipher.suites、ssl.protocol、ssl.enabled.protocols、webserver.http.cors.enabled、webserver.http.cors.origin、webserver.http.cors.exposeheaders)
map
metrics	`metrics` プロパティーは非推奨となり、`spec.cruiseControl.metricsConfig` を使用して設定する必要があります。metrics プロパティーは API バージョン `v1beta2` で削除されます。Prometheus JMX エクスポーターの設定。この設定の構造に関する詳細は、https://github.com/prometheus/jmx_exporter を参照してください。
map
metricsConfig	メトリクスの設定。タイプは、指定のオブジェクト内の `metricsConfig.type` プロパティーの値によって異なり、[jmxPrometheusExporter] の 1 つでなければなりません。
`JmxPrometheusExporterMetrics`

13.2.72. `CruiseControlTemplate` スキーマ参照

CruiseControlSpec で使用

プロパティー	説明
deployment	Cruise Control `Deployment` のテンプレート。
`ResourceTemplate`	Cruise Control `Deployment` のテンプレート。
pod	Cruise Control `Pods` のテンプレート。
`PodTemplate`	Cruise Control `Pods` のテンプレート。
apiService	Cruise Control API `Service` のテンプレート。
`ResourceTemplate`	Cruise Control API `Service` のテンプレート。
podDisruptionBudget	Cruise Control `PodDisruptionBudget` のテンプレート。
`PodDisruptionBudgetTemplate`	Cruise Control `PodDisruptionBudget` のテンプレート。
cruiseControlContainer	Cruise Control コンテナーのテンプレート。
`ContainerTemplate`	Cruise Control コンテナーのテンプレート。
tlsSidecarContainer	Cruise Control TLS サイドカーコンテナーのテンプレート。
`ContainerTemplate`	Cruise Control TLS サイドカーコンテナーのテンプレート。

13.2.73. `BrokerCapacity` スキーマ参照

CruiseControlSpec で使用

プロパティー	説明
disk	ディスクのバイト単位のブローカー容量 (例: 100Gi)
string	ディスクのバイト単位のブローカー容量 (例: 100Gi)
cpuUtilization	パーセントで表された CPU リソース使用率のブローカー容量 (0 - 100)。
integer	パーセントで表された CPU リソース使用率のブローカー容量 (0 - 100)。
inboundNetwork	バイト毎秒単位のインバウンドネットワークスループットのブローカー容量 (例: 10000KB/s)。
string	バイト毎秒単位のインバウンドネットワークスループットのブローカー容量 (例: 10000KB/s)。
outboundNetwork	バイト毎秒単位のアウトバウンドネットワークスループットのブローカー容量 (例: 10000KB/s)。
string	バイト毎秒単位のアウトバウンドネットワークスループットのブローカー容量 (例: 10000KB/s)。

13.2.74. `KafkaExporterSpec` スキーマ参照

KafkaSpec で使用

プロパティー	説明
image	Pod の Docker イメージ。
string	Pod の Docker イメージ。
groupRegex	収集するコンシューマーグループを指定する正規表現。デフォルト値は `.*` です。
string	収集するコンシューマーグループを指定する正規表現。デフォルト値は `.*` です。
topicRegex	収集するトピックを指定する正規表現。デフォルト値は `.*` です。
string	収集するトピックを指定する正規表現。デフォルト値は `.*` です。
resources	予約する CPU およびメモリーリソース。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements
logging	指定の重大度以上のログメッセージのみ。有効な値は [`debug`、`info`、`warn`、`error`、`fatal`] です。デフォルトのログレベルは `info` です。
string
enableSaramaLogging	Kafka Exporter によって使用される Go クライアントライブラリーである Sarama ロギングを有効にします。
boolean
template	デプロイメントテンプレートおよび Pod のカスタマイズ。
`KafkaExporterTemplate`	デプロイメントテンプレートおよび Pod のカスタマイズ。
livenessProbe	Pod の liveness チェック。
`Probe`	Pod の liveness チェック。
readinessProbe	Pod の readiness チェック。
`Probe`	Pod の readiness チェック。

13.2.75. `KafkaExporterTemplate` スキーマ参照

KafkaExporterSpec で使用

プロパティー	説明
deployment	Kafka Exporter `Deployment` のテンプレート。
`ResourceTemplate`	Kafka Exporter `Deployment` のテンプレート。
pod	Kafka Exporter `Pods` のテンプレート。
`PodTemplate`	Kafka Exporter `Pods` のテンプレート。
service	Kafka Exporter `Service` のテンプレート。
`ResourceTemplate`	Kafka Exporter `Service` のテンプレート。
container	Kafka Exporter コンテナーのテンプレート。
`ContainerTemplate`	Kafka Exporter コンテナーのテンプレート。

13.2.76. `KafkaStatus` スキーマ参照

Kafka で使用

プロパティー	説明
conditions	ステータス条件の一覧。
`Condition` array	ステータス条件の一覧。
observedGeneration	最後に Operator によって調整された CRD の生成。
integer	最後に Operator によって調整された CRD の生成。
listeners	内部リスナーおよび外部リスナーのアドレス。
`ListenerStatus` array	内部リスナーおよび外部リスナーのアドレス。
clusterId	Kafka クラスター ID。
string	Kafka クラスター ID。

13.2.77. `Condition` スキーマ参照

KafkaBridgeStatus、KafkaConnectorStatus、KafkaConnectS2IStatus、KafkaConnectStatus、KafkaMirrorMaker2Status、KafkaMirrorMakerStatus、KafkaRebalanceStatus、KafkaStatus、KafkaTopicStatus、KafkaUserStatus で使用

プロパティー	説明
type	リソース内の他の条件と区別するために使用される条件の固有識別子。
string	リソース内の他の条件と区別するために使用される条件の固有識別子。
status	条件のステータス (True、False、または Unknown のいずれか)。
string	条件のステータス (True、False、または Unknown のいずれか)。
lastTransitionTime	タイプの条件がある状態から別の状態へと最後に変更した時間。必須形式は、UTC タイムゾーンの 'yyyy-MM-ddTHH:mm:ssZ' です。
string
reason	条件の最後の遷移の理由 (CamelCase の単一の単語)。
string	条件の最後の遷移の理由 (CamelCase の単一の単語)。
message	条件の最後の遷移の詳細を示す、人間が判読できるメッセージ。
string	条件の最後の遷移の詳細を示す、人間が判読できるメッセージ。

13.2.78. `ListenerStatus` スキーマ参照

KafkaStatus で使用

プロパティー	説明
type	リスナーのタイプ。次の 3 つのタイプのいずれかになります: `plain`、`tls`、または `external`
string	リスナーのタイプ。次の 3 つのタイプのいずれかになります: `plain`、`tls`、または `external`
addresses	このリスナーのアドレス一覧。
`ListenerAddress` array	このリスナーのアドレス一覧。
bootstrapServers	このリスナーを使用して Kafka クラスターに接続するための `host:port` ペアのコンマ区切りリスト。
string	このリスナーを使用して Kafka クラスターに接続するための `host:port` ペアのコンマ区切りリスト。
certificates	指定のリスナーへの接続時に、サーバーのアイデンティティーを検証するために使用できる TLS 証明書の一覧。`tls` および `external` リスナーにのみ設定。
string array

13.2.79. `ListenerAddress` スキーマ参照

ListenerStatus で使用

プロパティー	説明
host	Kafka ブートストラップサービスの DNS 名または IP アドレス。
string	Kafka ブートストラップサービスの DNS 名または IP アドレス。
port	Kafka ブートストラップサービスのポート。
integer	Kafka ブートストラップサービスのポート。

13.2.80. `KafkaConnect` スキーマ参照

プロパティー	説明
spec	Kafka Connect クラスターの仕様。
`KafkaConnectSpec`	Kafka Connect クラスターの仕様。
status	Kafka Connect クラスターのステータス。
`KafkaConnectStatus`	Kafka Connect クラスターのステータス。

13.2.81. `KafkaConnectSpec` スキーマ参照

KafkaConnect で使用

KafkaConnectSpec スキーマプロパティーの完全リスト

Kafka Connect クラスターを設定します。

13.2.81.1. `config`

config プロパティーを使用して、Kafka オプションをキーとして設定します。

標準の Apache Kafka Connect 設定が提供されることがありますが、AMQ Streams によって直接管理されないプロパティーに限定されます。

以下に関連する設定オプションは設定できません。

Kafka クラスターブートストラップアドレス
セキュリティー (暗号化、認証、および承認)
リスナー / REST インターフェースの設定
プラグインパスの設定

値は以下の JSON タイプのいずれかになります。

文字列
数値
ブール値

AMQ Streams で直接管理されるオプションを除き、Apache Kafka ドキュメントに記載されているオプションを指定および設定できます。以下の文字列の 1 つと同じキーまたは以下の文字列の 1 つで始まるキーを持つ設定オプションは禁止されています。

ssl.
sasl.
security.
listeners
plugin.path
rest.
bootstrap.servers

禁止されているオプションが config プロパティーにある場合、そのオプションは無視され、警告メッセージが Cluster Operator ログファイルに出力されます。その他のオプションはすべて Kafka Connect に渡されます。

重要

提供された config オブジェクトのキーまたは値は Cluster Operator によって検証されません。無効な設定を指定すると、Kafka Connect クラスターが起動しなかったり、不安定になる可能性があります。この状況で、KafkaConnect.spec.config または KafkaConnectS2I.spec.config オブジェクトの設定を修正すると、Cluster Operator は新しい設定をすべての Kafka Connect ノードにロールアウトできます。

以下のオプションにはデフォルト値があります。

group.id、デフォルト値 connect-cluster
offset.storage.topic、デフォルト値 connect-cluster-offsets
config.storage.topic、デフォルト値 connect-cluster-configs
status.storage.topic、デフォルト値 connect-cluster-status
key.converter、デフォルト値 org.apache.kafka.connect.json.JsonConverter
value.converter、デフォルト値 org.apache.kafka.connect.json.JsonConverter

これらのオプションは、KafkaConnect.spec.config または KafkaConnectS2I.spec.config プロパティーになかった場合に自動的に設定されます。

禁止されているオプションには例外があります。TLS バージョンの特定の 暗号スイート を使用して、クライアント接続に許可される 3 つの ssl 設定オプションを使用します。暗号スイートは、セキュアな接続とデータ転送のためのアルゴリズムを組み合わせます。また、ssl.endpoint.identification.algorithm プロパティーを設定して、ホスト名の検証を有効または無効にすることもできます。

Kafka Connect の設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaConnect
metadata:
  name: my-connect
spec:
  # ...
  config:
    group.id: my-connect-cluster
    offset.storage.topic: my-connect-cluster-offsets
    config.storage.topic: my-connect-cluster-configs
    status.storage.topic: my-connect-cluster-status
    key.converter: org.apache.kafka.connect.json.JsonConverter
    value.converter: org.apache.kafka.connect.json.JsonConverter
    key.converter.schemas.enable: true
    value.converter.schemas.enable: true
    config.storage.replication.factor: 3
    offset.storage.replication.factor: 3
    status.storage.replication.factor: 3
    ssl.cipher.suites: "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
    ssl.enabled.protocols: "TLSv1.2"
    ssl.protocol: "TLSv1.2"
    ssl.endpoint.identification.algorithm: HTTPS
  # ...

TLS バージョンに特定の 暗号スイート を使用するクライアント接続では、許可された ssl プロパティーを設定できます。また、ssl.endpoint.identification.algorithm プロパティーを設定して、ホスト名の検証を有効または無効にすることもできます。

13.2.81.2. `logging`

Kafka Connect (および Source2Image サポートのある Kafka Connect) には独自の設定可能なロガーがあります。

connect.root.logger.level
log4j.logger.org.reflections

実行中の Kafka Connect プラグインに応じて、さらにロガーが追加されます。

curl リクエストを使用して、Kafka ブローカー Pod から稼働している Kafka Connect ロガーの完全リストを取得します。

curl -s http://<connect-cluster-name>-connect-api:8083/admin/loggers/

Kafka Connect では Apache log4j ロガー実装が使用されます。

logging プロパティーを使用してロガーおよびロガーレベルを設定します。

inline および external ロギングの例は次のとおりです。

inline ロギング

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaConnect
spec:
  # ...
  logging:
    type: inline
    loggers:
      connect.root.logger.level: "INFO"
  # ...

外部ロギング

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaConnect
spec:
  # ...
  logging:
    type: external
    valueFrom:
      configMapKeyRef:
        name: customConfigMap
        key: connect-logging.log4j
  # ...

設定されていない利用可能なロガーのレベルは OFF に設定されています。

Cluster Operator を使用して Kafka Connect がデプロイされた場合、Kafka Connect のロギングレベルの変更は動的に適用されます。

外部ロギングを使用する場合は、ロギングアペンダーが変更されるとローリングアップデートがトリガーされます。

ガベッジコレクター (GC)

ガベッジコレクターのロギングは、jvmOptions プロパティーを使用して有効 (または無効) にすることもできます。

13.2.81.3. `KafkaConnectSpec` スキーマプロパティー

プロパティー	説明
version	Kafka Connect のバージョン。デフォルトは 2.7.0 です。バージョンのアップグレードまたはダウングレードに必要なプロセスを理解するには、ユーザードキュメントを参照してください。
string
replicas	Kafka Connect グループの Pod 数。
integer	Kafka Connect グループの Pod 数。
image	Pod の Docker イメージ。
string	Pod の Docker イメージ。
bootstrapServers	接続するブートストラップサーバー。これは <hostname>:‍<port> ペアのコンマ区切りリストとして指定する必要があります。
string
tls	TLS 設定。
`KafkaConnectTls`	TLS 設定。
authentication	Kafka Connect の認証設定。タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[tls、scram-sha-512、plain、oauth] のいずれかでなければなりません。
`KafkaClientAuthenticationTls`, `KafkaClientAuthenticationScramSha512`, `KafkaClientAuthenticationPlain`, `KafkaClientAuthenticationOAuth`
config	Kafka Connect の設定。次の接頭辞を持つプロパティーは設定できません: ssl.、sasl.、security.、listeners、plugin.path、rest.、bootstrap.servers、consumer.interceptor.classes、producer.interceptor.classes (ssl.endpoint.identification.algorithm、ssl.cipher.suites、ssl.protocol、ssl.enabled.protocols を除く)
map
resources	CPU とメモリーリソースおよび要求された初期リソースの上限。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements
livenessProbe	Pod の liveness チェック。
`Probe`	Pod の liveness チェック。
readinessProbe	Pod の readiness チェック。
`Probe`	Pod の readiness チェック。
jvmOptions	Pod の JVM オプション。
`JvmOptions`	Pod の JVM オプション。
jmxOptions	JMX オプション。
`KafkaJmxOptions`	JMX オプション。
affinity	`affinity` プロパティーは非推奨となり、`spec.template.pod.affinity` を使用して設定する必要があります。affinity プロパティーは API バージョン `v1beta2` で削除されます。Pod のアフィニティールール。詳細は、core/v1 affinity の外部ドキュメントを参照してください。
Affinity
tolerations	`tolerations` プロパティーは非推奨となり、`spec.template.pod.tolerations` を使用して設定する必要があります。tolerations プロパティーは API バージョン `v1beta2` で削除されます。Pod の許容 (Toleration)。詳細は、core/v1 toleration の外部ドキュメントを参照してください。
Toleration array
logging	Kafka Connect のロギング設定。タイプは、指定のオブジェクト内の `logging.type` プロパティーの値によって異なり、[inline、external] のいずれかでなければなりません。
`InlineLogging`, `ExternalLogging`
metrics	`metrics` プロパティーは非推奨となり、`spec.metricsConfig` を使用して設定する必要があります。metrics プロパティーは API バージョン `v1beta2` で削除されます。Prometheus JMX エクスポーターの設定。この設定の構造に関する詳細は、https://github.com/prometheus/jmx_exporter を参照してください。
map
tracing	Kafka Connect でのトレーシングの設定。タイプは、指定のオブジェクト内の `tracing.type` プロパティーの値によって異なり、[jaeger] の 1 つでなければなりません。
`JaegerTracing`
template	Kafka Connect および Kafka Connect S2I リソースのテンプレート。テンプレートを使用すると、ユーザーは `Deployment`、`Pods`、および `Service` の生成方法を指定できます。
`KafkaConnectTemplate`
externalConfiguration	Secret または ConfigMap から Kafka Connect Pod にデータを渡し、これを使用してコネクターを設定します。
`ExternalConfiguration`
build	Connect コンテナーイメージを構築する方法を設定します。任意設定。
`Build`	Connect コンテナーイメージを構築する方法を設定します。任意設定。
clientRackInitImage	`client.rack` の初期化に使用される init コンテナーのイメージ。
string	`client.rack` の初期化に使用される init コンテナーのイメージ。
metricsConfig	メトリクスの設定。タイプは、指定のオブジェクト内の `metricsConfig.type` プロパティーの値によって異なり、[jmxPrometheusExporter] の 1 つでなければなりません。
`JmxPrometheusExporterMetrics`
rack	client.rack コンシューマー設定として使用されるノードラベルの設定。
`Rack`	client.rack コンシューマー設定として使用されるノードラベルの設定。

13.2.82. `KafkaConnectTls` スキーマ参照

KafkaConnectS2ISpec、KafkaConnectSpec で使用

KafkaConnectTls スキーマプロパティーの完全リスト

Kafka Connect をクラスターに接続するために TLS で信頼される証明書を設定します。

13.2.82.1. `trustedCertificates`

trustedCertificates プロパティーを使用してシークレットのリストを提供します。

13.2.82.2. `KafkaConnectTls` スキーマプロパティー

プロパティー	説明
trustedCertificates	TLS 接続の信頼済み証明書。
`CertSecretSource` array	TLS 接続の信頼済み証明書。

13.2.83. `KafkaClientAuthenticationTls` スキーマ参照

KafkaBridgeSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2ClusterSpec、KafkaMirrorMakerConsumerSpec、KafkaMirrorMakerProducerSpec で使用

KafkaClientAuthenticationTls スキーマプロパティーの完全リスト

TLS クライアント認証を設定するには、type プロパティーを tls の値に設定します。TLS クライアント認証は TLS 証明書を使用して認証します。

13.2.83.1. `certificateAndKey`

証明書は certificateAndKey プロパティーで指定され、常に OpenShift シークレットからロードされます。シークレットでは、公開鍵と秘密鍵の 2 つの鍵を使用して証明書を X509 形式で保存する必要があります。

User Operator によって作成されたシークレットを使用できます。または、認証に使用される鍵で独自の TLS 証明書ファイルを作成し、ファイルから Secret を作成することもできます。

oc create secret generic MY-SECRET \
--from-file=MY-PUBLIC-TLS-CERTIFICATE-FILE.crt \
--from-file=MY-PRIVATE.key

注記

TLS クライアント認証は TLS 接続でのみ使用できます。

TLS クライアント認証の設定例

authentication:
  type: tls
  certificateAndKey:
    secretName: my-secret
    certificate: my-public-tls-certificate-file.crt
    key: private.key

13.2.83.2. `KafkaClientAuthenticationTls` スキーマプロパティー

type プロパティーは、KafkaClientAuthenticationTls タイプの使用を KafkaClientAuthenticationScramSha512、KafkaClientAuthenticationPlain、および KafkaClientAuthenticationOAuth と区別する識別子です。KafkaClientAuthenticationTls タイプには tls の値が必要です。

プロパティー	説明
certificateAndKey	証明書と秘密鍵のペアを保持する `Secret` への参照。
`CertAndKeySecretSource`	証明書と秘密鍵のペアを保持する `Secret` への参照。
type	`tls` でなければなりません。
string	`tls` でなければなりません。

13.2.84. `KafkaClientAuthenticationScramSha512` スキーマ参照

KafkaBridgeSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2ClusterSpec、KafkaMirrorMakerConsumerSpec、KafkaMirrorMakerProducerSpec で使用

KafkaClientAuthenticationScramSha512 スキーマプロパティーの完全リスト

SASL ベースの SCRAM-SHA-512 認証を設定するには、type プロパティーを scram-sha-512 に設定します。SCRAM-SHA-512 認証メカニズムには、ユーザー名とパスワードが必要です。

13.2.84.1. `username`

username プロパティーでユーザー名を指定します。

13.2.84.2. `passwordSecret`

passwordSecret プロパティーで、パスワードを含む Secret へのリンクを指定します。

User Operator によって作成されたシークレットを使用できます。

必要に応じて、認証に使用するクリアテキストのパスワードが含まれるテキストファイルを作成できます。

echo -n PASSWORD > MY-PASSWORD.txt

次に、テキストファイルから Secret を作成し、パスワードに独自のフィールド名 (鍵) を設定できます。

oc create secret generic MY-CONNECT-SECRET-NAME --from-file=MY-PASSWORD-FIELD-NAME=./MY-PASSWORD.txt

Kafka Connect の SCRAM-SHA-512 クライアント認証の Secret 例

apiVersion: v1
kind: Secret
metadata:
  name: my-connect-secret-name
type: Opaque
data:
  my-connect-password-field: LFTIyFRFlMmU2N2Tm

secretName プロパティーには Secret の名前が含まれ、password プロパティーには Secret 内にパスワードが格納される鍵の名前が含まれます。

重要

password プロパティーには、実際のパスワードを指定しないでください。

Kafka Connect の SASL ベース SCRAM-SHA-512 クライアント認証の設定例

authentication:
  type: scram-sha-512
  username: my-connect-username
  passwordSecret:
    secretName: my-connect-secret-name
    password: my-connect-password-field

13.2.84.3. `KafkaClientAuthenticationScramSha512` スキーマプロパティー

type プロパティーは、KafkaClientAuthenticationScramSha512 タイプの使用を KafkaClientAuthenticationTls、KafkaClientAuthenticationPlain、および KafkaClientAuthenticationOAuth と区別する識別子です。KafkaClientAuthenticationScramSha512 タイプには scram-sha-512 の値が必要です。

プロパティー	説明
passwordSecret	パスワードを保持する `Secret` への参照。
`PasswordSecretSource`	パスワードを保持する `Secret` への参照。
type	`scram-sha-512` でなければなりません。
string	`scram-sha-512` でなければなりません。
username	認証に使用されるユーザー名。
string	認証に使用されるユーザー名。

13.2.85. `PasswordSecretSource` スキーマ参照

KafkaClientAuthenticationPlain、KafkaClientAuthenticationScramSha512 で使用

プロパティー	説明
password	パスワードが保存される Secret のキーの名前。
string	パスワードが保存される Secret のキーの名前。
secretName	パスワードを含むシークレットの名前。
string	パスワードを含むシークレットの名前。

13.2.86. `KafkaClientAuthenticationPlain` スキーマ参照

KafkaBridgeSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2ClusterSpec、KafkaMirrorMakerConsumerSpec、KafkaMirrorMakerProducerSpec で使用

KafkaClientAuthenticationPlain スキーマプロパティーの完全リスト

SASL ベースの PLAIN 認証を設定するには、type プロパティーを plain に設定します。SASL PLAIN 認証メカニズムには、ユーザー名とパスワードが必要です。

警告

SASL PLAIN メカニズムは、クリアテキストでユーザー名とパスワードをネットワーク全体に転送します。TLS による暗号化が有効になっている場合にのみ SASL PLAIN 認証を使用します。

13.2.86.1. `username`

username プロパティーでユーザー名を指定します。

13.2.86.2. `passwordSecret`

passwordSecret プロパティーで、パスワードを含む Secret へのリンクを指定します。

User Operator によって作成されたシークレットを使用できます。

必要に応じて、認証に使用するクリアテキストのパスワードが含まれるテキストファイルを作成します。

echo -n PASSWORD > MY-PASSWORD.txt

次に、テキストファイルから Secret を作成し、パスワードに独自のフィールド名 (鍵) を設定できます。

oc create secret generic MY-CONNECT-SECRET-NAME --from-file=MY-PASSWORD-FIELD-NAME=./MY-PASSWORD.txt

Kafka Connect の PLAIN クライアント認証の Secret 例

apiVersion: v1
kind: Secret
metadata:
  name: my-connect-secret-name
type: Opaque
data:
  my-password-field-name: LFTIyFRFlMmU2N2Tm

secretName プロパティーには Secret の名前が含まれ、password プロパティーには Secret 内にパスワードが格納されるキーの名前が含まれます。

重要

password プロパティーには、実際のパスワードを指定しないでください。

SASL ベースの PLAIN クライアント認証の設定例

authentication:
  type: plain
  username: my-connect-username
  passwordSecret:
    secretName: my-connect-secret-name
    password: my-password-field-name

13.2.86.3. `KafkaClientAuthenticationPlain` スキーマプロパティー

type プロパティーは、KafkaClientAuthenticationPlain タイプの使用を KafkaClientAuthenticationTls、KafkaClientAuthenticationScramSha512、および KafkaClientAuthenticationOAuth と区別する識別子です。KafkaClientAuthenticationPlain タイプには plain の値が必要です。

プロパティー	説明
passwordSecret	パスワードを保持する `Secret` への参照。
`PasswordSecretSource`	パスワードを保持する `Secret` への参照。
type	`plain` でなければなりません。
string	`plain` でなければなりません。
username	認証に使用されるユーザー名。
string	認証に使用されるユーザー名。

13.2.87. `KafkaClientAuthenticationOAuth` スキーマ参照

KafkaBridgeSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2ClusterSpec、KafkaMirrorMakerConsumerSpec、KafkaMirrorMakerProducerSpec で使用

KafkaClientAuthenticationOAuth スキーマプロパティーの完全リスト

OAuth クライアント認証を設定するには、type プロパティーを oauth に設定します。

OAuth 認証は、以下のオプションのいずれかを使用して設定できます。

クライアント ID およびシークレット
クライアント ID および更新トークン
アクセストークン
TLS

クライアント ID およびシークレット

認証で使用されるクライアント ID およびクライアントシークレットとともに、tokenEndpointUri プロパティーで承認サーバーのアドレスを設定できます。OAuth クライアントは OAuth サーバーに接続し、クライアント ID およびシークレットを使用して認証し、Kafka ブローカーとの認証に使用するアクセストークンを取得します。clientSecret プロパティーで、クライアントシークレットが含まれる Secret へのリンクを指定します。

クライアント ID およびクライアントシークレットを使用した OAuth クライアント認証の例

authentication:
  type: oauth
  tokenEndpointUri: https://sso.myproject.svc:8443/auth/realms/internal/protocol/openid-connect/token
  clientId: my-client-id
  clientSecret:
    secretName: my-client-oauth-secret
    key: client-secret

クライアント ID および更新トークン

OAuth クライアント ID および更新トークンとともに、tokenEndpointUri プロパティーで OAuth サーバーのアドレスを設定できます。OAuth クライアントは OAuth サーバーに接続し、クライアント ID と更新トークンを使用して認証し、Kafka ブローカーとの認証に使用するアクセストークンを取得します。refreshToken プロパティーで、更新トークンが含まれる Secret へのリンクを指定します。

クライアント ID と更新トークンを使用した OAuth クライアント認証の例

authentication:
  type: oauth
  tokenEndpointUri: https://sso.myproject.svc:8443/auth/realms/internal/protocol/openid-connect/token
  clientId: my-client-id
  refreshToken:
    secretName: my-refresh-token-secret
    key: refresh-token

アクセストークン

Kafka ブローカーとの認証に使用されるアクセストークンを直接設定できます。この場合、tokenEndpointUri は指定しません。accessToken プロパティーで、アクセストークンが含まれる Secret へのリンクを指定します。

アクセストークンのみを使用した OAuth クライアント認証の例

authentication:
  type: oauth
  accessToken:
    secretName: my-access-token-secret
    key: access-token

TLS

HTTPS プロトコルを使用して OAuth サーバーにアクセスする場合、信頼される認証局によって署名された証明書を使用し、そのホスト名が証明書に記載されている限り、追加の設定は必要ありません。

OAuth サーバーが自己署名証明書を使用している場合、または信頼されていない認証局によって署名されている場合は、カスタムリソースで信頼済み証明書の一覧を設定できます。tlsTrustedCertificates プロパティーには、保存される証明書のキー名があるシークレットのリストが含まれます。証明書は X509 形式で保存する必要があります。

提供される TLS 証明書の例

authentication:
  type: oauth
  tokenEndpointUri: https://sso.myproject.svc:8443/auth/realms/internal/protocol/openid-connect/token
  clientId: my-client-id
  refreshToken:
    secretName: my-refresh-token-secret
    key: refresh-token
  tlsTrustedCertificates:
    - secretName: oauth-server-ca
      certificate: tls.crt

OAuth クライアントはデフォルトで、OAuth サーバーのホスト名が、証明書サブジェクトまたは別の DNS 名のいずれかと一致することを確認します。必要でない場合は、ホスト名の検証を無効にできます。

無効にされた TLS ホスト名の検証例

authentication:
  type: oauth
  tokenEndpointUri: https://sso.myproject.svc:8443/auth/realms/internal/protocol/openid-connect/token
  clientId: my-client-id
  refreshToken:
    secretName: my-refresh-token-secret
    key: refresh-token
  disableTlsHostnameVerification: true

13.2.87.1. `KafkaClientAuthenticationOAuth` スキーマプロパティー

type プロパティーは、KafkaClientAuthenticationOAuth タイプの使用を KafkaClientAuthenticationTls、KafkaClientAuthenticationScramSha512、および KafkaClientAuthenticationPlain と区別する識別子です。KafkaClientAuthenticationOAuth タイプには oauth の値が必要です。

プロパティー	説明
accessToken	承認サーバーから取得したアクセストークンが含まれる OpenShift シークレットへのリンク。
`GenericSecretSource`	承認サーバーから取得したアクセストークンが含まれる OpenShift シークレットへのリンク。
accessTokenIsJwt	アクセストークンを JWT として処理すべきかどうかを設定します。承認サーバーが不透明なトークンを返す場合は `false` に設定する必要があります。デフォルトは `true` です。
boolean
clientId	Kafka クライアントが OAuth サーバーに対する認証に使用し、トークンエンドポイント URI を使用することができる OAuth クライアント ID。
string
clientSecret	Kafka クライアントが OAuth サーバーに対する認証に使用し、トークンエンドポイント URI を使用することができる OAuth クライアントシークレットが含まれる OpenShift シークレットへのリンク。
`GenericSecretSource`
disableTlsHostnameVerification	TLS ホスト名の検証を有効または無効にします。デフォルト値は `false` です。
boolean	TLS ホスト名の検証を有効または無効にします。デフォルト値は `false` です。
maxTokenExpirySeconds	アクセストークンの有効期間を指定の秒数に設定または制限します。これは、承認サーバーが不透明なトークンを返す場合に設定する必要があります。
integer
refreshToken	承認サーバーからアクセストークンを取得するために使用できる更新トークンが含まれる OpenShift シークレットへのリンク。
`GenericSecretSource`
scope	承認サーバーに対して認証を行うときに使用する OAuth スコープ。一部の承認サーバーでこれを設定する必要があります。許可される値は、承認サーバーの設定によります。デフォルトでは、トークンエンドポイントリクエストを実行する場合は `scope` は指定されません。
string
tlsTrustedCertificates	OAuth サーバーへの TLS 接続の信頼済み証明書。
`CertSecretSource` array	OAuth サーバーへの TLS 接続の信頼済み証明書。
tokenEndpointUri	承認サーバートークンエンドポイント URI。
string	承認サーバートークンエンドポイント URI。
type	`oauth` でなければなりません。
string	`oauth` でなければなりません。

13.2.88. `JaegerTracing` スキーマ参照

KafkaBridgeSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2Spec、KafkaMirrorMakerSpec で使用

type プロパティーは、JaegerTracing タイプの使用を、今後追加される可能性のある他のサブタイプと区別する識別子です。JaegerTracing タイプには jaeger の値が必要です。

プロパティー	説明
type	`jaeger` でなければなりません。
string	`jaeger` でなければなりません。

13.2.89. `KafkaConnectTemplate` スキーマ参照

KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2Spec で使用

プロパティー	説明
deployment	Kafka Connect `Deployment` のテンプレート。
`DeploymentTemplate`	Kafka Connect `Deployment` のテンプレート。
pod	Kafka Connect `Pods` のテンプレート。
`PodTemplate`	Kafka Connect `Pods` のテンプレート。
apiService	Kafka Connect API `Service` のテンプレート。
`ResourceTemplate`	Kafka Connect API `Service` のテンプレート。
buildConfig	新しいコンテナーイメージをビルドするために使用される Kafka Connect BuildConfig のテンプレート。BuildConfig は OpenShift でのみ使用されます。
`ResourceTemplate`
buildContainer	Kafka Connect Build コンテナーのテンプレート。build コンテナーは OpenShift でのみ使用されます。
`ContainerTemplate`
buildPod	Kafka Connect Build `Pods` のテンプレート。build Pod は OpenShift でのみ使用されます。
`PodTemplate`
clusterRoleBinding	Kafka Connect ClusterRoleBinding のテンプレート。
`ResourceTemplate`	Kafka Connect ClusterRoleBinding のテンプレート。
connectContainer	Kafka Connect コンテナーのテンプレート。
`ContainerTemplate`	Kafka Connect コンテナーのテンプレート。
initContainer	Kafka init コンテナーのテンプレート。
`ContainerTemplate`	Kafka init コンテナーのテンプレート。
podDisruptionBudget	Kafka Connect `PodDisruptionBudget` のテンプレート。
`PodDisruptionBudgetTemplate`	Kafka Connect `PodDisruptionBudget` のテンプレート。

13.2.90. `DeploymentTemplate` スキーマ参照

KafkaBridgeTemplate、KafkaConnectTemplate、KafkaMirrorMakerTemplate で使用

プロパティー	説明
metadata	リソースに適用済みのメタデータ。
`MetadataTemplate`	リソースに適用済みのメタデータ。
deploymentStrategy	このデプロイメントに使用される DeploymentStrategy。有効な値は `RollingUpdate` および `Recreate` です。デフォルトは `RollingUpdate` です。
string ([RollingUpdate、Recreate] のいずれか)

13.2.91. `ExternalConfiguration` スキーマ参照

KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2Spec で使用

ExternalConfiguration スキーマプロパティーの完全リスト

Kafka Connect コネクターの設定オプションを定義する外部ストレージプロパティーを設定します。

ConfigMap またはシークレットを環境変数またはボリュームとして Kafka Connect Pod にマウントできます。ボリュームおよび環境変数は、KafkaConnect.spec および KafkaConnectS2I.spec の externalConfiguration プロパティーで設定されます。

これが適用されると、コネクターの開発時に環境変数とボリュームを使用できます。

13.2.91.1. `env`

env プロパティーは、1 つ以上の環境変数を指定するために使用されます。これらの変数には ConfigMap または Secret からの値を含めることができます。

環境変数の値が含まれるシークレットの例

apiVersion: v1
kind: Secret
metadata:
  name: aws-creds
type: Opaque
data:
  awsAccessKey: QUtJQVhYWFhYWFhYWFhYWFg=
  awsSecretAccessKey: Ylhsd1lYTnpkMjl5WkE=

注記

ユーザー定義の環境変数に、KAFKA_ または STRIMZI_ で始まる名前を付けることはできません。

Secret から環境変数に値をマウントするには、valueFrom プロパティーおよび secretKeyRef を使用します。

Secret からの値に設定された環境変数の例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaConnect
metadata:
  name: my-connect
spec:
  # ...
  externalConfiguration:
    env:
      - name: AWS_ACCESS_KEY_ID
        valueFrom:
          secretKeyRef:
            name: aws-creds
            key: awsAccessKey
      - name: AWS_SECRET_ACCESS_KEY
        valueFrom:
          secretKeyRef:
            name: aws-creds
            key: awsSecretAccessKey

シークレットを環境変数にマウントする一般的なユースケースとして、コネクターが Amazon AWS と通信する必要があり、クレデンシャルで AWS_ACCESS_KEY_ID および AWS_SECRET_ACCESS_KEY 環境変数を読み取る必要がある場合が挙げられます。

ConfigMap から環境変数に値をマウントするには、以下の例のように valueFromプロパティーで configMapKeyRef を使用します。

ConfigMap からの値に設定された環境変数の例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaConnect
metadata:
  name: my-connect
spec:
  # ...
  externalConfiguration:
    env:
      - name: MY_ENVIRONMENT_VARIABLE
        valueFrom:
          configMapKeyRef:
            name: my-config-map
            key: my-key

13.2.91.2. `volumes`

ConfigMap またはシークレットをボリュームとして Kafka Connect Pod にマウントすることもできます。

以下の場合、環境変数の代わりにボリュームを使用すると便利です。

TLS 証明書でのトラストストアまたはキーストアのマウント
Kafka Connect コネクターの設定に使用されるプロパティーファイルのマウント

プロパティーのある Secret の例

apiVersion: v1
kind: Secret
metadata:
  name: mysecret
type: Opaque
stringData:
  connector.properties: |- 1
    dbUsername: my-user 2
    dbPassword: my-password

1: プロパティーファイル形式のコネクター設定。
2: 設定で使用されるデータベースのユーザー名およびパスワードプロパティー。

この例では、mysecret という名前の Secret が connector-configという名前のボリュームにマウントされます。config プロパティーでは、外部ソースから設定値を読み込む設定プロバイダー (FileConfigProvider) が指定されます。Kafka FileConfigProvider にはエイリアス file が指定され、コネクター設定で使用するファイルからデータベースの ユーザー名 プロパティーおよび パスワード プロパティーの値を読み取りおよび展開します。

Secret からの値に設定された外部ボリュームの例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaConnect
metadata:
  name: my-connect
spec:
  # ...
  config:
    config.providers: file 1
    config.providers.file.class: org.apache.kafka.common.config.provider.FileConfigProvider 2
  #...
  externalConfiguration:
    volumes:
      - name: connector-config 3
        secret:
          secretName: mysecret 4

1: 他の設定パラメーターを定義するために使用される設定プロバイダーのエイリアス。複数のプロバイダーを追加する場合は、コンマ区切りリストを使用します。
2: FileConfigProvider は、プロパティーファイルから値を提供する設定プロバイダーです。パラメーターは config.providers からエイリアスを使用し、config.providers.${alias}.class という形式を取ります。
3: Secret が含まれるボリュームの名前。各ボリュームは name プロパティーに名前を指定し、ConfigMap またはシークレットを参照する必要があります。
4: Secret の名前。

ボリュームは、パス /opt/kafka/external-configuration/<volume-name> の Kafka Connect コンテナーの内部にマウントされます。たとえば、connector-config いう名前のボリュームからのファイルは /opt/kafka/external-configuration/connector-config ディレクトリーにあります。

FileConfigProvider を使用して、コネクター設定でマウントされたプロパティーファイルから値を読み取ります。

13.2.91.3. `ExternalConfiguration` スキーマプロパティー

プロパティー	説明
env	Secret または ConfigMap からのデータを環境変数として Kafka Connect Pod に渡すことを許可します。
`ExternalConfigurationEnv` array
volumes	Secret または ConfigMap からのデータをボリュームとして Kafka Connect Pod に渡すことを許可します。
`ExternalConfigurationVolumeSource` array

13.2.92. `ExternalConfigurationEnv` スキーマ参照

ExternalConfiguration で使用

プロパティー	説明
name	Kafka Connect Pod に渡される環境変数の名前。環境変数に、`KAFKA_` または `STRIMZI_` で始まる名前を付けることはできません。
string
valueFrom	Kafka Connect Pod に渡される環境変数の値。Secret または ConfigMap フィールドのいずれかへ参照として渡すことができます。このフィールドでは、Secret または ConfigMap を 1 つだけ指定する必要があります。
`ExternalConfigurationEnvVarSource`

13.2.93. `ExternalConfigurationEnvVarSource` スキーマ参照

ExternalConfigurationEnv で使用

プロパティー	説明
configMapKeyRef	ConfigMap のキーへの参照。詳細は、core/v1 configmapkeyselector の外部ドキュメントを参照してください。
ConfigMapKeySelector
secretKeyRef	Secret のキーへの参照。詳細は、core/v1 secretkeyselector の外部ドキュメントを参照してください。
SecretKeySelector

13.2.94. `ExternalConfigurationVolumeSource` スキーマ参照

ExternalConfiguration で使用

プロパティー	説明
configMap	ConfigMap のキーへの参照。Secret または ConfigMap を 1 つだけ指定する必要があります。詳細は、core/v1 configmapvolumesource の外部ドキュメントを参照してください。
ConfigMapVolumeSource
name	Kafka Connect Pod に追加されるボリュームの名前。
string	Kafka Connect Pod に追加されるボリュームの名前。
secret	Secret のキーへの参照。Secret または ConfigMap を 1 つだけ指定する必要があります。詳細は、core/v1 secretvolumesource の外部ドキュメントを参照してください。
SecretVolumeSource

13.2.95. `Build` スキーマ参照

KafkaConnectS2ISpec、KafkaConnectSpec で使用

Build スキーマプロパティーの完全リスト

Kafka Connect デプロイメントの追加コネクターを設定します。

13.2.95.1. `output`

追加のコネクタープラグインで新しいコンテナーイメージをビルドするには、イメージをプッシュ、保存、およびプルできるコンテナーレジストリーが AMQ Streams に必要です。AMQ Streams は独自のコンテナーレジストリーを実行しないため、レジストリーを指定する必要があります。AMQ Streams は、プライベートコンテナーレジストリーだけでなく、Quay や Docker Hub などのパブリックレジストリーもサポートします。コンテナーレジストリーは、KafkaConnect カスタムリソースの .spec.build.output セクションで設定されます。output 設定は必須で、docker と imagestream の 2 つのタイプをサポートします。

Docker レジストリーの使用

Docker レジストリーを使用するには、type を docker として指定し、image フィールドに新しいコンテナーイメージのフルネームを指定する必要があります。フルネームには以下が含まれる必要があります。

レジストリーのアドレス
ポート番号 (標準以外のポートでリッスンしている場合)
新しいコンテナーイメージのタグ

有効なコンテナーイメージ名の例:

docker.io/my-org/my-image/my-tag
quay.io/my-org/my-image/my-tag
image-registry.image-registry.svc:5000/myproject/kafka-connect-build:latest

Kafka Connect デプロイメントごとに個別のイメージを使用する必要があります。これは、最も基本的なレベルで異なるタグを使用する可能性があることを意味します。

レジストリーに認証が必要な場合は、pushSecret を使用してレジストリーのクレデンシャルで Secret の名前を設定します。Secret には、kubernetes.io/dockerconfigjson タイプと .dockerconfigjson ファイルを使用して Docker クレデンシャルを格納します。プライベートレジストリーからイメージをプルする方法の詳細は、「Create a Secret based on existing Docker credentials」を参照してください。

output の設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaConnect
metadata:
  name: my-connect-cluster
spec:
  #...
  build:
    output:
      type: docker 1
      image: my-registry.io/my-org/my-connect-cluster:latest 2
      pushSecret: my-registry-credentials 3
  #...

1: (必須) AMQ Streams によって使用される出力のタイプ。
2: (必須) リポジトリーとタグを含む、使用されるイメージのフルネーム。
3: (任意) コンテナーレジストリーのクレデンシャルが含まれるシークレットの名前。

OpenShift ImageStream の使用

Docker の代わりに OpenShift ImageStream を使用して、新しいコンテナーイメージを保存できます。Kafka Connect をデプロイする前に、ImageStream を手動で作成する必要があります。ImageStream を使用するには、type を imagestream に設定し、image プロパティーを使用して ImageStream と使用するタグの名前を指定します。例: my-connect-image-stream:latest

output の設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaConnect
metadata:
  name: my-connect-cluster
spec:
  #...
  build:
    output:
      type: imagestream 1
      image: my-connect-build:latest 2
  #...

1: (必須) AMQ Streams によって使用される出力のタイプ。
2: (必須) ImageStream およびタグの名前。

13.2.95.2. `plugins`

コネクタープラグインは、特定タイプの外部システムへの接続に必要な実装を定義するファイルのセットです。コンテナーイメージに必要なコネクタープラグインは、KafkaConnect カスタムリソースの .spec.build.plugins プロパティーを使用して設定する必要があります。各コネクタープラグインには、Kafka Connect デプロイメント内で一意となる名前が必要です。さらに、プラグインアーティファクトもリストする必要があります。これらのアーティファクトは AMQ Streams によってダウンロードされ、新しいコンテナーイメージに追加され、Kafka Connect デプロイメントで使用されます。コネクタープラグインアーティファクトには、シリアライザーやデシリアライザーなどの追加のコンポーネントを含めることもできます。各コネクタープラグインは、異なるコネクターとそれらの依存関係が適切に サンドボックス化 されるように、個別のディレクトリーにダウンロードされます。各プラグインは、1 つ以上の artifact で設定する必要があります。

2 つのコネクタープラグインを持つ plugins の設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaConnect
metadata:
  name: my-connect-cluster
spec:
  #...
  build:
    output:
      #...
    plugins: 1
      - name: debezium-postgres-connector
        artifacts:
          - type: tgz
            url: https://repo1.maven.org/maven2/io/debezium/debezium-connector-postgres/1.3.1.Final/debezium-connector-postgres-1.3.1.Final-plugin.tar.gz
            sha512sum: 962a12151bdf9a5a30627eebac739955a4fd95a08d373b86bdcea2b4d0c27dd6e1edd5cb548045e115e33a9e69b1b2a352bee24df035a0447cb820077af00c03
      - name: camel-telegram
        artifacts:
          - type: tgz
            url: https://repo.maven.apache.org/maven2/org/apache/camel/kafkaconnector/camel-telegram-kafka-connector/0.7.0/camel-telegram-kafka-connector-0.7.0-package.tar.gz
            sha512sum: a9b1ac63e3284bea7836d7d24d84208c49cdf5600070e6bd1535de654f6920b74ad950d51733e8020bf4187870699819f54ef5859c7846ee4081507f48873479
  #...

1: (必須) コネクタープラグインおよびそれらのアーティファクトの一覧。

AMQ Streams は、ダウンロードされ直接使用される JAR ファイルと、ダウンロードされ展開される TGZ アーカイブの 2種類のアーティファクトをサポートします。

重要

AMQ Streams は、ダウンロードしたアーティファクトのセキュリティースキャンを実行しません。セキュリティー上の理由から、最初にアーティファクトを手動で検証し、チェックサムの検証を設定して、自動ビルドと Kafka Connect デプロイメントで同じアーティファクトが使用されるようにする必要があります。

JAR アーティファクトの使用

JAR アーティファクトは、コンテナーイメージにダウンロードされ、追加されたリソースを表します。JAR アーティファクトは主に JAR ファイルのダウンロードに使用されますが、他のファイルタイプをダウンロードするために使用することもできます。JAR アーティファクトを使用するには、type プロパティーを jar に設定し、url プロパティーを使用してダウンロードする場所を指定します。

さらに、アーティファクトの SHA-512 チェックサムを指定することもできます。指定された場合、AMQ Streams は新しいコンテナーイメージのビルド中にアーティファクトのチェックサムを検証します。

JAR アーティファクトの例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaConnect
metadata:
  name: my-connect-cluster
spec:
  #...
  build:
    output:
      #...
    plugins:
      - name: my-plugin
        artifacts:
          - type: jar 1
            url: https://my-domain.tld/my-jar.jar 2
            sha512sum: 589...ab4 3
          - type: jar
            url: https://my-domain.tld/my-jar2.jar
  #...

1: (必須) アーティファクトのタイプ。
2: (必須) アーティファクトのダウンロード元 URL。
3: (任意) アーティファクトを検証する SHA-512 チェックサム。

TGZ アーティファクトの使用

TGZ アーティファクトは、Gzip 圧縮を使用して圧縮された TAR アーカイブをダウンロードするために使用されます。複数の異なるファイルで構成される場合でも、TGZ アーティファクトに Kafka Connect コネクター全体を含めることができます。TGZ アーティファクトは、新しいコンテナーイメージのビルド時に AMQ Streams によって自動的にダウンロードおよび展開されます。TGZ アーティファクトを使用するには、type プロパティーを tgz に設定し、url プロパティーを使用してダウンロードする場所を指定します。

さらに、アーティファクトの SHA-512 チェックサムを指定することもできます。指定された場合、展開して新しいコンテナイメージをビルドする前に、チェックサムが AMQ Streams によって検証されます。

TGZ アーティファクトの例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaConnect
metadata:
  name: my-connect-cluster
spec:
  #...
  build:
    output:
      #...
    plugins:
      - name: my-plugin
        artifacts:
          - type: tgz 1
            url: https://my-domain.tld/my-connector-archive.jar 2
            sha512sum: 158...jg10 3
  #...

1: (必須) アーティファクトのタイプ。
2: (必須) アーカイブのダウンロード元 URL。
3: (任意) アーティファクトを検証する SHA-512 チェックサム。

13.2.95.3. `Build` スキーマプロパティー

プロパティー	説明
output	新たにビルドされたイメージの保存先を設定します。必須です。タイプは、指定のオブジェクト内の `output.type` プロパティーの値によって異なり、[docker、imagestream] のいずれかでなければなりません。
`DockerOutput`, `ImageStreamOutput`
resources	ビルド用に予約する CPU およびメモリーリソース。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements
plugins	Kafka Connect に追加する必要のあるコネクタープラグインのリスト。必須です。
`Plugin` array	Kafka Connect に追加する必要のあるコネクタープラグインのリスト。必須です。

13.2.96. `DockerOutput` スキーマ参照

Build で使用

type プロパティーは、DockerOutput タイプの使用を ImageStreamOutput と区別する識別子です。DockerOutput タイプには docker の値が必要です。

プロパティー	説明
image	新たにビルドされたイメージのタグ付けおよびプッシュに使用されるフルネーム。例: `quay.io/my-organization/my-custom-connect:latest`必須です。
string
pushSecret	新たにビルドされたイメージをプッシュするための、クレデンシャルが含まれる Container Registry Secret。
string
additionalKanikoOptions	新しい Connect イメージをビルドする際に、Kaniko エグゼキューターに渡される追加オプションを設定します。指定できるオプションは --customPlatform、--insecure、--insecure-pull、--insecure-registry、--log-format、--log-timestamp、--registry-mirror、--reproducible、--single-snapshot、--skip-tls-verify、--skip-tls-verify-pull、--skip-tls-verify-registry、--verbosity、--snapshotMode、--use-new-run です。これらのオプションは、Kaniko エグゼキューターが使用される OpenShift でのみ使用されます。OpenShift では無視されます。オプションは、「Kaniko GitHub repository」に記載されています。このフィールドを変更しても、Kafka Connect イメージのビルドは新たにトリガーされません。
string array
type	`docker` でなければなりません。
string	`docker` でなければなりません。

13.2.97. `ImageStreamOutput` スキーマ参照

Build で使用

type プロパティーは、ImageStreamOutput タイプの使用を DockerOutput と区別する識別子です。ImageStreamOutput タイプには imagestream の値が必要です。

プロパティー	説明
image	新たにビルドされたイメージがプッシュされる ImageStream の名前およびタグ。例: `my-custom-connect:latest`必須です。
string
type	`imagestream` でなければなりません。
string	`imagestream` でなければなりません。

13.2.98. `Plugin` スキーマ参照

Build で使用

プロパティー	説明
name	コネクタープラグインの一意名。コネクターアーティファクトが保存されるパスの生成に使用されます。名前は KafkaConnect リソース内で一意である必要があります。この名前は、`^[a-z][-_a-z0-9]*[a-z]$` のパターンに従う必要があります。必須です。
string
artifacts	このコネクタープラグインに属するアーティファクトの一覧。必須です。
`JarArtifact`, `TgzArtifact`, `ZipArtifact` array	このコネクタープラグインに属するアーティファクトの一覧。必須です。

13.2.99. `JarArtifact` スキーマ参照

Plugin で使用

プロパティー	説明
url	ダウンロードされるアーティファクトの URL。AMQ Streams では、ダウンロードしたアーティファクトのセキュリティースキャンは行いません。セキュリティー上の理由から、最初にアーティファクトを手動で検証し、チェックサムの検証を設定して、自動ビルドで同じアーティファクトが使用されるようにする必要があります。必須です。
string
sha512sum	アーティファクトの SHA512 チェックサム。任意設定。指定すると、新しいコンテナーのビルド時にチェックサムが検証されます。指定のない場合は、ダウンロードしたアーティファクトは検証されません。
string
type	`jar` でなければなりません。
string	`jar` でなければなりません。

13.2.100. `TgzArtifact` スキーマ参照

Plugin で使用

プロパティー	説明
url	ダウンロードされるアーティファクトの URL。AMQ Streams では、ダウンロードしたアーティファクトのセキュリティースキャンは行いません。セキュリティー上の理由から、最初にアーティファクトを手動で検証し、チェックサムの検証を設定して、自動ビルドで同じアーティファクトが使用されるようにする必要があります。必須です。
string
sha512sum	アーティファクトの SHA512 チェックサム。任意設定。指定すると、新しいコンテナーのビルド時にチェックサムが検証されます。指定のない場合は、ダウンロードしたアーティファクトは検証されません。
string
type	`tgz` でなければなりません。
string	`tgz` でなければなりません。

13.2.101. `ZipArtifact` スキーマ参照

Plugin で使用

プロパティー	説明
url	ダウンロードされるアーティファクトの URL。AMQ Streams では、ダウンロードしたアーティファクトのセキュリティースキャンは行いません。セキュリティー上の理由から、最初にアーティファクトを手動で検証し、チェックサムの検証を設定して、自動ビルドで同じアーティファクトが使用されるようにする必要があります。必須です。
string
sha512sum	アーティファクトの SHA512 チェックサム。任意設定。指定すると、新しいコンテナーのビルド時にチェックサムが検証されます。指定のない場合は、ダウンロードしたアーティファクトは検証されません。
string
type	`zip` でなければなりません。
string	`zip` でなければなりません。

13.2.102. `KafkaConnectStatus` スキーマ参照

KafkaConnect で使用

プロパティー	説明
conditions	ステータス条件の一覧。
`Condition` array	ステータス条件の一覧。
observedGeneration	最後に Operator によって調整された CRD の生成。
integer	最後に Operator によって調整された CRD の生成。
url	Kafka Connect コネクターの管理および監視用の REST API エンドポイントの URL。
string	Kafka Connect コネクターの管理および監視用の REST API エンドポイントの URL。
connectorPlugins	この Kafka Connect デプロイメントで使用できるコネクタープラグインの一覧。
`ConnectorPlugin` array	この Kafka Connect デプロイメントで使用できるコネクタープラグインの一覧。
labelSelector	このリソースを提供する Pod のラベルセレクター。
string	このリソースを提供する Pod のラベルセレクター。
replicas	このリソースを提供するために現在使用されている Pod の数。
integer	このリソースを提供するために現在使用されている Pod の数。

13.2.103. `ConnectorPlugin` スキーマ参照

KafkaConnectS2IStatus、KafkaConnectStatus、KafkaMirrorMaker2Status で使用

プロパティー	説明
type	コネクタープラグインのタイプ。利用可能なタイプは、`sink` および `source` です。
string	コネクタープラグインのタイプ。利用可能なタイプは、`sink` および `source` です。
version	コネクタープラグインのバージョン。
string	コネクタープラグインのバージョン。
class	コネクタープラグインのクラス。
string	コネクタープラグインのクラス。

13.2.104. `KafkaConnectS2I` スキーマ参照

KafkaConnectS2I タイプは非推奨になりました。代わりに Build を使用してください。

プロパティー	説明
spec	Kafka Connect Source-to-Image (S2I) クラスターの仕様。
`KafkaConnectS2ISpec`	Kafka Connect Source-to-Image (S2I) クラスターの仕様。
status	Kafka Connect Source-to-Image (S2I) クラスターのステータス。
`KafkaConnectS2IStatus`	Kafka Connect Source-to-Image (S2I) クラスターのステータス。

13.2.105. `KafkaConnectS2ISpec` スキーマ参照

KafkaConnectS2I で使用

KafkaConnectS2ISpec スキーマプロパティーの完全リスト

Source-to-Image (S2I) サポートで Kafka Connect クラスターを設定します。

OpenShift (のみ) のコネクタープラグインで Kafka Connect を拡張する場合、OpenShift ビルドおよび S2I を使用して、Kafka Connect デプロイメントによって使用されるコンテナーイメージを作成できます。

設定オプションは、KafkaConnectSpec スキーマを使用した Kafka Connect 設定に似ています。

13.2.105.1. `KafkaConnectS2ISpec` スキーマプロパティー

プロパティー	説明
version	Kafka Connect のバージョン。デフォルトは 2.7.0 です。バージョンのアップグレードまたはダウングレードに必要なプロセスを理解するには、ユーザードキュメントを参照してください。
string
replicas	Kafka Connect グループの Pod 数。
integer	Kafka Connect グループの Pod 数。
image	Pod の Docker イメージ。
string	Pod の Docker イメージ。
buildResources	予約する CPU およびメモリーリソース。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements
bootstrapServers	接続するブートストラップサーバー。これは <hostname>:‍<port> ペアのコンマ区切りリストとして指定する必要があります。
string
tls	TLS 設定。
`KafkaConnectTls`	TLS 設定。
authentication	Kafka Connect の認証設定。タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[tls、scram-sha-512、plain、oauth] のいずれかでなければなりません。
`KafkaClientAuthenticationTls`, `KafkaClientAuthenticationScramSha512`, `KafkaClientAuthenticationPlain`, `KafkaClientAuthenticationOAuth`
config	Kafka Connect の設定。次の接頭辞を持つプロパティーは設定できません: ssl.、sasl.、security.、listeners、plugin.path、rest.、bootstrap.servers、consumer.interceptor.classes、producer.interceptor.classes (ssl.endpoint.identification.algorithm、ssl.cipher.suites、ssl.protocol、ssl.enabled.protocols を除く)
map
resources	CPU とメモリーリソースおよび要求された初期リソースの上限。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements
livenessProbe	Pod の liveness チェック。
`Probe`	Pod の liveness チェック。
readinessProbe	Pod の readiness チェック。
`Probe`	Pod の readiness チェック。
jvmOptions	Pod の JVM オプション。
`JvmOptions`	Pod の JVM オプション。
jmxOptions	JMX オプション。
`KafkaJmxOptions`	JMX オプション。
affinity	`affinity` プロパティーは非推奨となり、`spec.template.pod.affinity` を使用して設定する必要があります。affinity プロパティーは API バージョン `v1beta2` で削除されます。Pod のアフィニティールール。詳細は、core/v1 affinity の外部ドキュメントを参照してください。
Affinity
tolerations	`tolerations` プロパティーは非推奨となり、`spec.template.pod.tolerations` を使用して設定する必要があります。tolerations プロパティーは API バージョン `v1beta2` で削除されます。Pod の許容 (Toleration)。詳細は、core/v1 toleration の外部ドキュメントを参照してください。
Toleration array
logging	Kafka Connect のロギング設定。タイプは、指定のオブジェクト内の `logging.type` プロパティーの値によって異なり、[inline、external] のいずれかでなければなりません。
`InlineLogging`, `ExternalLogging`
metrics	`metrics` プロパティーは非推奨となり、`spec.metricsConfig` を使用して設定する必要があります。metrics プロパティーは API バージョン `v1beta2` で削除されます。Prometheus JMX エクスポーターの設定。この設定の構造に関する詳細は、https://github.com/prometheus/jmx_exporter を参照してください。
map
tracing	Kafka Connect でのトレーシングの設定。タイプは、指定のオブジェクト内の `tracing.type` プロパティーの値によって異なり、[jaeger] の 1 つでなければなりません。
`JaegerTracing`
template	Kafka Connect および Kafka Connect S2I リソースのテンプレート。テンプレートを使用すると、ユーザーは `Deployment`、`Pods`、および `Service` の生成方法を指定できます。
`KafkaConnectTemplate`
externalConfiguration	Secret または ConfigMap から Kafka Connect Pod にデータを渡し、これを使用してコネクターを設定します。
`ExternalConfiguration`
build	Connect コンテナーイメージを構築する方法を設定します。任意設定。
`Build`	Connect コンテナーイメージを構築する方法を設定します。任意設定。
clientRackInitImage	`client.rack` の初期化に使用される init コンテナーのイメージ。
string	`client.rack` の初期化に使用される init コンテナーのイメージ。
insecureSourceRepository	true の場合、'Local' 参照ポリシーとセキュアでないソースタグを受け入れるインポートポリシーを使用してソースリポジトリーを設定します。
boolean
metricsConfig	メトリクスの設定。タイプは、指定のオブジェクト内の `metricsConfig.type` プロパティーの値によって異なり、[jmxPrometheusExporter] の 1 つでなければなりません。
`JmxPrometheusExporterMetrics`
rack	client.rack コンシューマー設定として使用されるノードラベルの設定。
`Rack`	client.rack コンシューマー設定として使用されるノードラベルの設定。

13.2.106. `KafkaConnectS2IStatus` スキーマ参照

KafkaConnectS2I で使用

プロパティー	説明
conditions	ステータス条件の一覧。
`Condition` array	ステータス条件の一覧。
observedGeneration	最後に Operator によって調整された CRD の生成。
integer	最後に Operator によって調整された CRD の生成。
url	Kafka Connect コネクターの管理および監視用の REST API エンドポイントの URL。
string	Kafka Connect コネクターの管理および監視用の REST API エンドポイントの URL。
connectorPlugins	この Kafka Connect デプロイメントで使用できるコネクタープラグインの一覧。
`ConnectorPlugin` array	この Kafka Connect デプロイメントで使用できるコネクタープラグインの一覧。
buildConfigName	ビルド設定の名前。
string	ビルド設定の名前。
labelSelector	このリソースを提供する Pod のラベルセレクター。
string	このリソースを提供する Pod のラベルセレクター。
replicas	このリソースを提供するために現在使用されている Pod の数。
integer	このリソースを提供するために現在使用されている Pod の数。

13.2.107. `KafkaTopic` スキーマ参照

プロパティー	説明
spec	トピックの仕様。
`KafkaTopicSpec`	トピックの仕様。
status	トピックのステータス。
`KafkaTopicStatus`	トピックのステータス。

13.2.108. `KafkaTopicSpec` スキーマ参照

KafkaTopic で使用

プロパティー	説明
partitions	トピックに存在するパーティション数。この数はトピック作成後に減らすことはできません。トピック作成後に増やすことはできますが、その影響について理解することが重要となります。特にセマンティックパーティションのあるトピックで重要となります。
integer
replicas	トピックのレプリカ数。
integer	トピックのレプリカ数。
config	トピックの設定。
map	トピックの設定。
topicName	トピックの名前。これがない場合、デフォルトではトピックの metadata.name に設定されます。トピック名が有効な OpenShift リソース名ではない場合を除き、これを設定しないことが推奨されます。
string

13.2.109. `KafkaTopicStatus` スキーマ参照

KafkaTopic で使用

プロパティー	説明
conditions	ステータス条件の一覧。
`Condition` array	ステータス条件の一覧。
observedGeneration	最後に Operator によって調整された CRD の生成。
integer	最後に Operator によって調整された CRD の生成。

13.2.110. `KafkaUser` スキーマ参照

プロパティー	説明
spec	ユーザーの仕様。
`KafkaUserSpec`	ユーザーの仕様。
status	Kafka User のステータス。
`KafkaUserStatus`	Kafka User のステータス。

13.2.111. `KafkaUserSpec` スキーマ参照

KafkaUser で使用

プロパティー	説明
authentication	この Kafka ユーザーに対して有効になっている認証メカニズム。タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[tls、scram-sha-512] のいずれかでなければなりません。
`KafkaUserTlsClientAuthentication`, `KafkaUserScramSha512ClientAuthentication`
authorization	この Kafka ユーザーの承認ルール。タイプは、指定のオブジェクト内の `authorization.type` プロパティーの値によって異なり、[simple] の 1 つでなければなりません。
`KafkaUserAuthorizationSimple`
quotas	クライアントによって使用されるブローカーリソースを制御する要求のクォータ。ネットワーク帯域幅および要求レートクォータの適用が可能です。Kafka ユーザークォータの Kafka ドキュメントは http://kafka.apache.org/documentation/#design_quotas を参照してください。
`KafkaUserQuotas`
template	Kafka User `Secrets` の生成方法を指定するテンプレート。
`KafkaUserTemplate`	Kafka User `Secrets` の生成方法を指定するテンプレート。

13.2.112. `KafkaUserTlsClientAuthentication` スキーマ参照

KafkaUserSpec で使用

type プロパティーは、KafkaUserTlsClientAuthentication タイプの使用を KafkaUserScramSha512ClientAuthentication と区別する識別子です。KafkaUserTlsClientAuthentication タイプには tls の値が必要です。

プロパティー	説明
type	`tls` でなければなりません。
string	`tls` でなければなりません。

13.2.113. `KafkaUserScramSha512ClientAuthentication` スキーマ参照

KafkaUserSpec で使用

type プロパティーは、KafkaUserScramSha512ClientAuthentication タイプの使用を KafkaUserTlsClientAuthentication と区別する識別子です。KafkaUserScramSha512ClientAuthentication タイプには scram-sha-512 の値が必要です。

プロパティー	説明
type	`scram-sha-512` でなければなりません。
string	`scram-sha-512` でなければなりません。

13.2.114. `KafkaUserAuthorizationSimple` スキーマ参照

KafkaUserSpec で使用

type プロパティーは、KafkaUserAuthorizationSimple タイプの使用を、今後追加される可能性のある他のサブタイプと区別する識別子です。KafkaUserAuthorizationSimple タイプには simple の値が必要です。

プロパティー	説明
type	`simple` でなければなりません。
string	`simple` でなければなりません。
ACL	このユーザーに適用される必要のある ACL ルールの一覧。
`AclRule` array	このユーザーに適用される必要のある ACL ルールの一覧。

13.2.115. `AclRule` スキーマ参照

KafkaUserAuthorizationSimple で使用

AclRule スキーマプロパティーの完全リスト

ブローカーが AclAuthorizer を使用する場合に KafkaUser のアクセス制御ルールを設定します。

承認を使用した KafkaUser の設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaUser
metadata:
  name: my-user
  labels:
    strimzi.io/cluster: my-cluster
spec:
  # ...
  authorization:
    type: simple
    acls:
      - resource:
          type: topic
          name: my-topic
          patternType: literal
        operation: Read
      - resource:
          type: topic
          name: my-topic
          patternType: literal
        operation: Describe
      - resource:
          type: group
          name: my-group
          patternType: prefix
        operation: Read

13.2.115.1. `resource`

resource プロパティーを使用して、ルールが適用されるリソースを指定します。

簡易承認は、type プロパティーに指定される、以下の 4 つのリソースタイプをサポートします。

トピック (topic)
コンシューマーグループ (group)
クラスター (cluster)
トランザクション ID (transactionalId)

Topic、Group、および Transactional ID リソースでは、name プロパティーでルールが適用されるリソースの名前を指定できます。

クラスタータイプのリソースには名前がありません。

名前は、patternType プロパティーを使用して literal または prefix として指定されます。

リテラル (literal) 名には、name フィールドに指定された名前がそのまま使われます。
接頭辞 (prefix) 名には、name からの値が接頭辞として使用され、その値で始まる名前を持つすべてのリソースにルールが適用されます。

13.2.115.2. `type`

ルールの type。allow (操作の許可) または deny (操作の拒否、現在未サポート) です。

type フィールドの設定は任意です。type の指定がない場合、ACL ルールは allow ルールとして処理されます。

13.2.115.3. `operation`

ルールが許可または拒否する operation を指定します。

以下の操作がサポートされます。

Read
Write
Delete
Alter
Describe
All
IdempotentWrite
ClusterAction
Create
AlterConfigs
DescribeConfigs

特定の操作のみが各リソースで機能します。

AclAuthorizer、ACL、およびサポートされるリソースと操作の組み合わせの詳細は、「Authorization and ACL」を参照してください。

13.2.115.4. `host`

host プロパティーを使用して、ルールが許可または拒否されるリモートホストを指定します。

アスタリスク (*) を使用して、すべてのホストからの操作を許可または拒否します。host フィールドの設定は任意です。host を指定しないと、値 * がデフォルトで使用されます。

13.2.115.5. `AclRule` スキーマプロパティー

プロパティー	説明
host	ACL ルールに記述されているアクションを許可または拒否するホスト。
string	ACL ルールに記述されているアクションを許可または拒否するホスト。
operation	許可または拒否される操作。サポートされる操作: Read、Write、Create、Delete、Alter、Describe、ClusterAction、AlterConfigs、DescribeConfigs、IdempotentWrite、All
string ([Read、Write、Delete、Alter、Describe、All、IdempotentWrite、ClusterAction、Create、AlterConfigs、DescribeConfigs] のいずれか)
resource	指定の ACL ルールが適用されるリソースを示します。タイプは、指定のオブジェクト内の `resource.type` プロパティーの値によって異なり、[topic、group、cluster、transactionalId] のいずれかでなければなりません。
`AclRuleTopicResource`, `AclRuleGroupResource`, `AclRuleClusterResource`, `AclRuleTransactionalIdResource`
type	ルールのタイプ。現在サポートされているタイプは `allow` のみです。`allow` タイプの ACL ルールを使用すると、ユーザーは指定した操作を実行できます。デフォルト値は `allow` です。
string ([allow、deny] のいずれか)

13.2.116. `AclRuleTopicResource` スキーマ参照

AclRule で使用

type プロパティーは、AclRuleTopicResource タイプの使用を AclRuleGroupResource、AclRuleClusterResource、および AclRuleTransactionalIdResource と区別する識別子です。AclRuleTopicResource タイプには topic の値が必要です。

プロパティー	説明
type	`topic` でなければなりません。
string	`topic` でなければなりません。
name	指定の ACL ルールが適用されるリソースの名前。`patternType` フィールドと組み合わせて、接頭辞のパターンを使用できます。
string
patternType	リソースフィールドで使用されるパターンを指定します。サポートされるタイプは `literal` および `prefix` です。`literal` パターンタイプでは、リソースフィールドは完全なトピック名の定義として使用されます。`prefix` パターンタイプでは、リソース名は接頭辞としてのみ使用されます。デフォルト値は `literal` です。
string ([prefix、literal] のいずれか)

13.2.117. `AclRuleGroupResource` スキーマ参照

AclRule で使用

type プロパティーは、AclRuleGroupResource タイプの使用を AclRuleTopicResource、AclRuleClusterResource、および AclRuleTransactionalIdResource と区別する識別子です。AclRuleGroupResource タイプには group の値が必要です。

プロパティー	説明
type	`group` でなければなりません。
string	`group` でなければなりません。
name	指定の ACL ルールが適用されるリソースの名前。`patternType` フィールドと組み合わせて、接頭辞のパターンを使用できます。
string
patternType	リソースフィールドで使用されるパターンを指定します。サポートされるタイプは `literal` および `prefix` です。`literal` パターンタイプでは、リソースフィールドは完全なトピック名の定義として使用されます。`prefix` パターンタイプでは、リソース名は接頭辞としてのみ使用されます。デフォルト値は `literal` です。
string ([prefix、literal] のいずれか)

13.2.118. `AclRuleClusterResource` スキーマ参照

AclRule で使用

type プロパティーは、AclRuleClusterResource タイプの使用を AclRuleTopicResource、AclRuleGroupResource、および AclRuleTransactionalIdResource と区別する識別子です。AclRuleClusterResource タイプには cluster の値が必要です。

プロパティー	説明
type	`cluster` でなければなりません。
string	`cluster` でなければなりません。

13.2.119. `AclRuleTransactionalIdResource` スキーマ参照

AclRule で使用

type プロパティーは、AclRuleTransactionalIdResource タイプの使用を AclRuleTopicResource、AclRuleGroupResource、および AclRuleClusterResource と区別する識別子です。AclRuleTransactionalIdResource タイプには transactionalId の値が必要です。

プロパティー	説明
type	`transactionalId` でなければなりません。
string	`transactionalId` でなければなりません。
name	指定の ACL ルールが適用されるリソースの名前。`patternType` フィールドと組み合わせて、接頭辞のパターンを使用できます。
string
patternType	リソースフィールドで使用されるパターンを指定します。サポートされるタイプは `literal` および `prefix` です。`literal` パターンタイプでは、リソースフィールドはフルネームの定義として使用されます。`prefix` パターンタイプでは、リソース名は接頭辞としてのみ使用されます。デフォルト値は `literal` です。
string ([prefix、literal] のいずれか)

13.2.120. `KafkaUserQuotas` スキーマ参照

KafkaUserSpec で使用

KafkaUserQuotas スキーマプロパティーの完全リスト

Kafka では、ユーザーは quotas を設定してクライアントによるリソースの使用を制御できます。

13.2.120.1. `quotas`

クォータは、2 つのカテゴリーに分類されます。

ネットワーク使用率 クォータ。これは、クォータを共有するクライアントの各グループのバイトレートしきい値として定義されます。
CPU 使用率 クォータ。これは、クライアントがクォータウィンドウ内の各ブローカーのリクエストハンドラー I/O スレッドおよびネットワークスレッドで使用可能な時間の割合として定義されます。

Kafka クライアントにクォータを使用することは、さまざまな状況で役に立つ場合があります。レートが高すぎる要求を送信する Kafka プロデューサーを誤って設定したとします。このように設定が間違っていると、他のクライアントにサービス拒否を引き起こす可能性があるため、問題のあるクライアントはブロックする必要があります。ネットワーク制限クォータを使用すると、他のクライアントがこの状況の著しい影響を受けないようにすることが可能です。

AMQ Streams はユーザーレベルのクォータをサポートしますが、クライアントレベルのクォータはサポートしません。

Kafka ユーザークォータの例

spec:
  quotas:
    producerByteRate: 1048576
    consumerByteRate: 2097152
    requestPercentage: 55

Kafka ユーザークォータの詳細は Apache Kafka ドキュメントを参照してください。

13.2.120.2. `KafkaUserQuotas` スキーマプロパティー

プロパティー	説明
consumerByteRate	グループのクライアントにスロットリングが適用される前に、各クライアントグループがブローカーから取得できる最大 bps (ビット毎秒) のクオータ。ブローカーごとに定義されます。
integer
producerByteRate	グループのクライアントにスロットリングが適用される前に、各クライアントグループがブローカーにパブリッシュできる最大 bps (ビット毎秒) のクオータ。ブローカーごとに定義されます。
integer
requestPercentage	各クライアントグループの最大 CPU 使用率のクォータ。ネットワークと I/O スレッドの比率 (パーセント) として指定。
integer

13.2.121. `KafkaUserTemplate` スキーマ参照

KafkaUserSpec で使用

KafkaUserTemplate スキーマプロパティーの完全リスト

User Operator によって作成されるシークレットの追加ラベルおよびアノテーションを指定します。

KafkaUserTemplate を示す例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaUser
metadata:
  name: my-user
  labels:
    strimzi.io/cluster: my-cluster
spec:
  authentication:
    type: tls
  template:
    secret:
      metadata:
        labels:
          label1: value1
        annotations:
          anno1: value1
  # ...

13.2.121.1. `KafkaUserTemplate` スキーマプロパティー

プロパティー	説明
secret	KafkaUser リソースのテンプレート。テンプレートを使用すると、ユーザーはパスワードまたは TLS 証明書のある `Secret` の生成方法を指定できます。
`ResourceTemplate`

13.2.122. `KafkaUserStatus` スキーマ参照

KafkaUser で使用

プロパティー	説明
conditions	ステータス条件の一覧。
`Condition` array	ステータス条件の一覧。
observedGeneration	最後に Operator によって調整された CRD の生成。
integer	最後に Operator によって調整された CRD の生成。
username	ユーザー名。
string	ユーザー名。
secret	認証情報が保存される `Secret` の名前。
string	認証情報が保存される `Secret` の名前。

13.2.123. `KafkaMirrorMaker` スキーマ参照

プロパティー	説明
spec	Kafka MirrorMaker の仕様。
`KafkaMirrorMakerSpec`	Kafka MirrorMaker の仕様。
status	Kafka MirrorMaker のステータス。
`KafkaMirrorMakerStatus`	Kafka MirrorMaker のステータス。

13.2.124. `KafkaMirrorMakerSpec` スキーマ参照

KafkaMirrorMaker で使用

KafkaMirrorMakerSpec スキーマプロパティーの完全リスト

Kafka MirrorMaker を設定します。

13.2.124.1. `whitelist`

whitelist プロパティーを使用して、Kafka MirrorMaker がソースからターゲット Kafka クラスターにミラーリングするトピックのリストを設定します。

このプロパティーでは、簡単な単一のトピック名から複雑なパターンまですべての正規表現が許可されます。たとえば、「A|B」を使用してトピック A と B をミラーリングでき、「*」を使用してすべてのトピックをミラーリングできます。また、複数の正規表現をコンマで区切って Kafka MirrorMaker に渡すこともできます。

13.2.124.2. `KafkaMirrorMakerConsumerSpec` および `KafkaMirrorMakerProducerSpec`

KafkaMirrorMakerConsumerSpec および KafkaMirrorMakerProducerSpec を使用して、ソース (コンシューマー) およびターゲット (プロデューサー) クラスターを設定します。

Kafka MirrorMaker は常に 2 つの Kafka クラスター (ソースおよびターゲット) と連携します。接続を確立するため、ソースおよびターゲット Kafka クラスターのブートストラップサーバーは HOSTNAME:PORT ペアのコンマ区切りリストとして指定されます。それぞれのコンマ区切りリストには、HOSTNAME:PORT ペアとして指定された 1 つ以上の Kafka ブローカーまたは Kafka ブローカーを示す 1 つの Service が含まれます。

13.2.124.3. `logging`

Kafka MirrorMaker には、独自の設定可能なロガーがあります。

mirrormaker.root.logger

MirrorMaker では Apache log4j ロガー実装が使用されます。

logging プロパティーを使用してロガーおよびロガーレベルを設定します。

inline および external ロギングの例は次のとおりです。

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaMirrorMaker
spec:
  # ...
  logging:
    type: inline
    loggers:
      mirrormaker.root.logger: "INFO"
  # ...

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaMirrorMaker
spec:
  # ...
  logging:
    type: external
    valueFrom:
      configMapKeyRef:
        name: customConfigMap
        key: mirror-maker-log4j.properties
  # ...

ガベッジコレクター (GC)

ガベッジコレクターのロギングは、jvmOptions プロパティーを使用して有効 (または無効) にすることもできます。

13.2.124.4. `KafkaMirrorMakerSpec` スキーマプロパティー

プロパティー	説明
version	Kafka MirrorMaker のバージョン。デフォルトは 2.7.0 です。バージョンのアップグレードまたはダウングレードに必要なプロセスを理解するには、ドキュメントを参照してください。
string
replicas	`Deployment` の Pod 数。
integer	`Deployment` の Pod 数。
image	Pod の Docker イメージ。
string	Pod の Docker イメージ。
consumer	ソースクラスターの設定。
`KafkaMirrorMakerConsumerSpec`	ソースクラスターの設定。
producer	ターゲットクラスターの設定。
`KafkaMirrorMakerProducerSpec`	ターゲットクラスターの設定。
resources	予約する CPU およびメモリーリソース。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements
whitelist	ミラーリングに含まれるトピックの一覧。このオプションは、Java スタイルの正規表現を使用するあらゆる正規表現を許可します。`'A\|B'` をホワイトリストに指定すると、A と B という名前の 2 つのトピックをミラーリングすることができます。または、特殊なケースとして、'*' をホワイトリストに指定するとすべてのトピックをミラーリングできます。複数の正規表現をコンマで区切って指定することもできます。
string
affinity	`affinity` プロパティーは非推奨となり、`spec.template.pod.affinity` を使用して設定する必要があります。affinity プロパティーは API バージョン `v1beta2` で削除されます。Pod のアフィニティールール。詳細は、core/v1 affinity の外部ドキュメントを参照してください。
Affinity
tolerations	`tolerations` プロパティーは非推奨となり、`spec.template.pod.tolerations` を使用して設定する必要があります。tolerations プロパティーは API バージョン `v1beta2` で削除されます。Pod の許容 (Toleration)。詳細は、core/v1 toleration の外部ドキュメントを参照してください。
Toleration array
jvmOptions	Pod の JVM オプション。
`JvmOptions`	Pod の JVM オプション。
logging	MirrorMaker のロギング設定。タイプは、指定のオブジェクト内の `logging.type` プロパティーの値によって異なり、[inline、external] のいずれかでなければなりません。
`InlineLogging`, `ExternalLogging`
metrics	`metrics` プロパティーは非推奨となり、`spec.metricsConfig` を使用して設定する必要があります。metrics プロパティーは API バージョン `v1beta2` で削除されます。Prometheus JMX エクスポーターの設定。この設定の構造に関する詳細は、JMX Exporter のドキュメントを参照してください。
map
metricsConfig	メトリクスの設定。タイプは、指定のオブジェクト内の `metricsConfig.type` プロパティーの値によって異なり、[jmxPrometheusExporter] の 1 つでなければなりません。
`JmxPrometheusExporterMetrics`
tracing	Kafka MirrorMaker でのトレーシングの設定。タイプは、指定のオブジェクト内の `tracing.type` プロパティーの値によって異なり、[jaeger] の 1 つでなければなりません。
`JaegerTracing`
template	Kafka MirrorMaker のリソースである `Deployments` および `Pods`の生成方法を指定するテンプレート。
`KafkaMirrorMakerTemplate`
livenessProbe	Pod の liveness チェック。
`Probe`	Pod の liveness チェック。
readinessProbe	Pod の readiness チェック。
`Probe`	Pod の readiness チェック。

13.2.125. `KafkaMirrorMakerConsumerSpec` スキーマ参照

KafkaMirrorMakerSpec で使用

KafkaMirrorMakerConsumerSpec スキーマプロパティーの完全リスト

MirrorMaker コンシューマーを設定します。

13.2.125.1. `numStreams`

consumer.numStreams プロパティーを使用して、コンシューマーのストリームの数を設定します。

コンシューマースレッドの数を増やすと、ミラーリングトピックのスループットを増やすことができます。コンシューマースレッドは、Kafka MirrorMaker に指定されたコンシューマーグループに属します。トピックパーティションはコンシューマースレッド全体に割り当てられ、メッセージが並行して消費されます。

13.2.125.2. `offsetCommitInterval`

consumer.offsetCommitInterval プロパティーを使用して、コンシューマーのオフセット自動コミット間隔を設定します。

Kafka MirrorMaker によってソース Kafka クラスターのデータが消費された後に、オフセットがコミットされる通常の間隔を指定できます。間隔はミリ秒単位で設定され、デフォルト値は 60,000 です。

13.2.125.3. `config`

consumer.config プロパティーを使用して、コンシューマーの Kafka オプションを設定します。

config プロパティーには、Kafka MirrorMaker コンシューマー設定オプションが鍵として含まれ、値は以下の JSON タイプのいずれかに設定されます。

文字列
数値
ブール値

例外

コンシューマー向けの Apache Kafka 設定ドキュメントに記載されているオプションを指定および設定できます。

しかし、以下に関連する AMQ Streams によって自動的に設定され、直接管理されるオプションには例外があります。

Kafka クラスターブートストラップアドレス
セキュリティー (暗号化、認証、および承認)
コンシューマーグループ識別子
インターセプター

以下の文字列の 1 つと同じキーまたは以下の文字列の 1 つで始まるキーを持つ設定オプションはすべて禁止されています。

bootstrap.servers
group.id
interceptor.classes
ssl. (特定の例外は除外)
sasl.
security.

禁止されているオプションが config プロパティーにある場合、そのオプションは無視され、警告メッセージが Cluster Operator ログファイルに出力されます。その他のオプションはすべて Kafka MirrorMaker に渡されます。

重要

Cluster Operator では、提供された config オブジェクトのキーまたは値は検証されません。無効な設定が指定されると、Kafka MirrorMaker が起動しなかったり、不安定になったりする場合があります。このような場合、KafkaMirrorMaker.spec.consumer.config オブジェクトの設定を修正し、Cluster Operator によって Kafka MirrorMaker の新しい設定がロールアウトされるようにします。

13.2.125.4. `groupId`

consumer.groupId プロパティーを使用して、コンシューマーにコンシューマーグループ ID を設定します。

Kafka MirrorMaker は Kafka コンシューマーを使用してメッセージを消費し、他の Kafka コンシューマークライアントと同様に動作します。ソース Kafka クラスターから消費されるメッセージは、ターゲット Kafka クラスターにミラーリングされます。パーティションの割り当てには、コンシューマーがコンシューマーグループの一部である必要があるため、グループ ID が必要です。

13.2.125.5. `KafkaMirrorMakerConsumerSpec` スキーマプロパティー

プロパティー	説明
numStreams	作成するコンシューマーストリームスレッドの数を指定します。
integer	作成するコンシューマーストリームスレッドの数を指定します。
offsetCommitInterval	オフセットの自動コミット間隔をミリ秒単位で指定します。デフォルト値は 60000 です。
integer	オフセットの自動コミット間隔をミリ秒単位で指定します。デフォルト値は 60000 です。
bootstrapServers	Kafka クラスターへの最初の接続を確立するための host:port ペアの一覧。
string	Kafka クラスターへの最初の接続を確立するための host:port ペアの一覧。
groupId	このコンシューマーが属するコンシューマーグループを識別する一意の文字列。
string	このコンシューマーが属するコンシューマーグループを識別する一意の文字列。
authentication	クラスターに接続するための認証設定。タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[tls、scram-sha-512、plain、oauth] のいずれかでなければなりません。
`KafkaClientAuthenticationTls`, `KafkaClientAuthenticationScramSha512`, `KafkaClientAuthenticationPlain`, `KafkaClientAuthenticationOAuth`
config	MirrorMaker コンシューマーの設定。次の接頭辞を持つプロパティーは設定できません: ssl.、bootstrap.servers、group.id、sasl.、security.、interceptor.classes (次の例外を除く: ssl.endpoint.identification.algorithm、ssl.cipher.suites、ssl.protocol、ssl.enabled.protocols).
map
tls	MirrorMaker をクラスターに接続するための TLS 設定。
`KafkaMirrorMakerTls`	MirrorMaker をクラスターに接続するための TLS 設定。

13.2.126. `KafkaMirrorMakerTls` スキーマ参照

KafkaMirrorMakerConsumerSpec、KafkaMirrorMakerProducerSpec で使用

KafkaMirrorMakerTls スキーマプロパティーの完全リスト

MirrorMaker をクラスターに接続するため、TLS によって信頼される証明書を設定します。

13.2.126.1. `trustedCertificates`

trustedCertificates プロパティーを使用してシークレットのリストを提供します。

13.2.126.2. `KafkaMirrorMakerTls` スキーマプロパティー

プロパティー	説明
trustedCertificates	TLS 接続の信頼済み証明書。
`CertSecretSource` array	TLS 接続の信頼済み証明書。

13.2.127. `KafkaMirrorMakerProducerSpec` スキーマ参照

KafkaMirrorMakerSpec で使用

KafkaMirrorMakerProducerSpec スキーマプロパティーの完全リスト

MirrorMaker プロデューサーを設定します。

13.2.127.1. `abortOnSendFailure`

producer.abortOnSendFailure プロパティーを使用して、プロデューサーからメッセージ送信の失敗を処理する方法を設定します。

デフォルトでは、メッセージを Kafka MirrorMaker から Kafka クラスターに送信する際にエラーが発生した場合、以下が行われます。

Kafka MirrorMaker コンテナーが OpenShift で終了します。
その後、コンテナーが再作成されます。

abortOnSendFailure オプションを false に設定した場合、メッセージ送信エラーは無視されます。

13.2.127.2. `config`

producer.config プロパティーを使用して、プロデューサーの Kafka オプションを設定します。

config プロパティーには、Kafka MirrorMaker プロデューサー設定オプションが鍵として含まれ、値は以下の JSON タイプのいずれかに設定されます。

文字列
数値
ブール値

例外

プロデューサー向けの Apache Kafka 設定ドキュメントに記載されているオプションを指定および設定できます。

しかし、以下に関連する AMQ Streams によって自動的に設定され、直接管理されるオプションには例外があります。

Kafka クラスターブートストラップアドレス
セキュリティー (暗号化、認証、および承認)
インターセプター

以下の文字列の 1 つと同じキーまたは以下の文字列の 1 つで始まるキーを持つ設定オプションはすべて禁止されています。

bootstrap.servers
interceptor.classes
ssl. (特定の例外は除外)
sasl.
security.

重要

Cluster Operator では、提供された config オブジェクトのキーまたは値は検証されません。無効な設定が指定されると、Kafka MirrorMaker が起動しなかったり、不安定になったりする場合があります。このような場合、KafkaMirrorMaker.spec.producer.config オブジェクトの設定を修正し、Cluster Operator によって Kafka MirrorMaker の新しい設定がロールアウトされるようにします。

13.2.127.3. `KafkaMirrorMakerProducerSpec` スキーマプロパティー

プロパティー	説明
bootstrapServers	Kafka クラスターへの最初の接続を確立するための host:port ペアの一覧。
string	Kafka クラスターへの最初の接続を確立するための host:port ペアの一覧。
abortOnSendFailure	送信失敗時に MirrorMaker が終了するように設定するフラグ。デフォルト値は `true` です。
boolean	送信失敗時に MirrorMaker が終了するように設定するフラグ。デフォルト値は `true` です。
authentication	クラスターに接続するための認証設定。タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[tls、scram-sha-512、plain、oauth] のいずれかでなければなりません。
`KafkaClientAuthenticationTls`, `KafkaClientAuthenticationScramSha512`, `KafkaClientAuthenticationPlain`, `KafkaClientAuthenticationOAuth`
config	MirrorMaker プロデューサーの設定。次の接頭辞を持つプロパティーは設定できません: ssl.、bootstrap.servers、sasl.、security.、interceptor.classes (次の例外を除く: ssl.endpoint.identification.algorithm、ssl.cipher.suites、ssl.protocol、ssl.enabled.protocols).
map
tls	MirrorMaker をクラスターに接続するための TLS 設定。
`KafkaMirrorMakerTls`	MirrorMaker をクラスターに接続するための TLS 設定。

13.2.128. `KafkaMirrorMakerTemplate` スキーマ参照

KafkaMirrorMakerSpec で使用

プロパティー	説明
deployment	Kafka MirrorMaker `Deployment` のテンプレート。
`DeploymentTemplate`	Kafka MirrorMaker `Deployment` のテンプレート。
pod	Kafka MirrorMaker `Pods` のテンプレート。
`PodTemplate`	Kafka MirrorMaker `Pods` のテンプレート。
mirrorMakerContainer	Kafka MirrorMaker コンテナーのテンプレート。
`ContainerTemplate`	Kafka MirrorMaker コンテナーのテンプレート。
podDisruptionBudget	Kafka MirrorMaker `PodDisruptionBudget` のテンプレート。
`PodDisruptionBudgetTemplate`	Kafka MirrorMaker `PodDisruptionBudget` のテンプレート。

13.2.129. `KafkaMirrorMakerStatus` スキーマ参照

KafkaMirrorMaker で使用

プロパティー	説明
conditions	ステータス条件の一覧。
`Condition` array	ステータス条件の一覧。
observedGeneration	最後に Operator によって調整された CRD の生成。
integer	最後に Operator によって調整された CRD の生成。
labelSelector	このリソースを提供する Pod のラベルセレクター。
string	このリソースを提供する Pod のラベルセレクター。
replicas	このリソースを提供するために現在使用されている Pod の数。
integer	このリソースを提供するために現在使用されている Pod の数。

13.2.130. `KafkaBridge` スキーマ参照

プロパティー	説明
spec	Kafka Bridge の仕様。
`KafkaBridgeSpec`	Kafka Bridge の仕様。
status	Kafka Bridge のステータス。
`KafkaBridgeStatus`	Kafka Bridge のステータス。

13.2.131. `KafkaBridgeSpec` スキーマ参照

KafkaBridge で使用

KafkaBridgeSpec スキーマプロパティーの完全リスト

Kafka Bridge クラスターを設定します。

設定オプションは以下に関連しています。

Kafka クラスターブートストラップアドレス
セキュリティー (暗号化、認証、および承認)
コンシューマー設定
プロデューサーの設定
HTTP の設定

13.2.131.1. `logging`

Kafka Bridge には独自の設定可能なロガーがあります。

logger.bridge
logger.<operation-id>

logger.<operation-id> ロガーの <operation-id> を置き換えると、特定の操作のログレベルを設定できます。

createConsumer
deleteConsumer
subscribe
unsubscribe
poll
assign
commit
send
sendToPartition
seekToBeginning
seekToEnd
seek
healthy
ready
openapi

各操作は OpenAPI 仕様にしたがって定義されます。各操作にはブリッジが HTTP クライアントから要求を受信する対象の API エンドポイントがあります。各エンドポイントのログレベルを変更すると、送信および受信 HTTP リクエストに関する詳細なログ情報を作成できます。

各ロガーは name を http.openapi.operation.<operation-id> として割り当てるように設定する必要があります。たとえば、send 操作ロガーのロギングレベルを設定すると、以下が定義されます。

logger.send.name = http.openapi.operation.send
logger.send.level = DEBUG

Kafka Bridge では Apache log4j2 ロガー実装が使用されます。ロガーは log4j2.properties ファイルで定義されます。このファイルには healthy および ready エンドポイントの以下のデフォルト設定が含まれています。

logger.healthy.name = http.openapi.operation.healthy
logger.healthy.level = WARN
logger.ready.name = http.openapi.operation.ready
logger.ready.level = WARN

その他すべての操作のログレベルは、デフォルトで INFO に設定されます。

logging プロパティーを使用してロガーおよびロガーレベルを設定します。

ログレベルを設定するには、ロガーとレベルを直接指定 (インライン) するか、またはカスタム (外部) ConfigMap を使用します。ConfigMap を使用する場合、logging.valueFrom.configMapKeyRef.name プロパティーを外部ロギング設定が含まれる ConfigMap の名前に設定します。logging.valueFrom.configMapKeyRef.name および logging.valueFrom.configMapKeyRef.key プロパティーは必須です。name または key が設定されていない場合、デフォルトのロギングが使用されます。ConfigMap 内では、ロギング設定は log4j.properties を使用して記述されます。ログレベルの詳細は、「Apache logging services」を参照してください。

inline および external ロギングの例は次のとおりです。

inline ロギング

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaBridge
spec:
  # ...
  logging:
    type: inline
    loggers:
      logger.bridge.level: "INFO"
      # enabling DEBUG just for send operation
      logger.send.name: "http.openapi.operation.send"
      logger.send.level: "DEBUG"
  # ...

外部ロギング

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaBridge
spec:
  # ...
  logging:
    type: external
    valueFrom:
      configMapKeyRef:
        name: customConfigMap
        key: bridge-logj42.properties
  # ...

設定されていない利用可能なロガーのレベルは OFF に設定されています。

Cluster Operator を使用して Kafka Bridge がデプロイされた場合、Kafka Bridge のロギングレベルの変更は動的に適用されます。

外部ロギングを使用する場合は、ロギングアペンダーが変更されるとローリングアップデートがトリガーされます。

ガベッジコレクター (GC)

ガベッジコレクターのロギングは、jvmOptions プロパティーを使用して有効 (または無効) にすることもできます。

13.2.131.2. `KafkaBridgeSpec` スキーマプロパティー

プロパティー	説明
replicas	`Deployment` の Pod 数。
integer	`Deployment` の Pod 数。
image	Pod の Docker イメージ。
string	Pod の Docker イメージ。
bootstrapServers	Kafka クラスターへの最初の接続を確立するための host:port ペアの一覧。
string	Kafka クラスターへの最初の接続を確立するための host:port ペアの一覧。
tls	Kafka Bridge をクラスターに接続するための TLS 設定。
`KafkaBridgeTls`	Kafka Bridge をクラスターに接続するための TLS 設定。
authentication	クラスターに接続するための認証設定。タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[tls、scram-sha-512、plain、oauth] のいずれかでなければなりません。
`KafkaClientAuthenticationTls`, `KafkaClientAuthenticationScramSha512`, `KafkaClientAuthenticationPlain`, `KafkaClientAuthenticationOAuth`
http	HTTP 関連の設定。
`KafkaBridgeHttpConfig`	HTTP 関連の設定。
consumer	Kafka コンシューマーに関連する設定。
`KafkaBridgeConsumerSpec`	Kafka コンシューマーに関連する設定。
producer	Kafka プロデューサーに関連する設定。
`KafkaBridgeProducerSpec`	Kafka プロデューサーに関連する設定。
resources	予約する CPU およびメモリーリソース。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements
jvmOptions	現時点でサポートされていない Pod の JVM オプション。
`JvmOptions`	現時点でサポートされていない Pod の JVM オプション。
logging	Kafka Bridge のロギング設定。タイプは、指定のオブジェクト内の `logging.type` プロパティーの値によって異なり、[inline、external] のいずれかでなければなりません。
`InlineLogging`, `ExternalLogging`
enableMetrics	Kafka Bridge のメトリクスを有効にします。デフォルトは false です。
boolean	Kafka Bridge のメトリクスを有効にします。デフォルトは false です。
livenessProbe	Pod の liveness チェック。
`Probe`	Pod の liveness チェック。
readinessProbe	Pod の readiness チェック。
`Probe`	Pod の readiness チェック。
template	Kafka Bridge リソースのテンプレート。テンプレートを使用すると、ユーザーは `Deployment` および `Pods` の生成方法を指定できます。
`KafkaBridgeTemplate`
tracing	Kafka Bridge でのトレーシングの設定。タイプは、指定のオブジェクト内の `tracing.type` プロパティーの値によって異なり、[jaeger] の 1 つでなければなりません。
`JaegerTracing`

13.2.132. `KafkaBridgeTls` スキーマ参照

KafkaBridgeSpec で使用

プロパティー	説明
trustedCertificates	TLS 接続の信頼済み証明書。
`CertSecretSource` array	TLS 接続の信頼済み証明書。

13.2.133. `KafkaBridgeHttpConfig` スキーマ参照

KafkaBridgeSpec で使用

KafkaBridgeHttpConfig スキーマプロパティーの完全リスト

Kafka Bridge の Kafka クラスターへの HTTP アクセスを設定します。

デフォルトの HTTP 設定では、8080 番ポートで Kafka Bridge をリッスンします。

13.2.133.1. `cors`

HTTP プロパティーは、Kafka クラスターへの HTTP アクセスを有効にする他に、CPRS (Cross-Origin Resource Sharing) により Kafka Bridge のアクセス制御を有効化または定義する機能を提供します。CORS は、複数のオリジンから指定のリソースにブラウザーでアクセスできるようにする HTTP メカニズムです。CORS を設定するには、許可されるリソースオリジンのリストと、HTTP のアクセス方法を定義します。オリジンには、URL または Java 正規表現を使用できます。

Kafka Bridge HTTP の設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaBridge
metadata:
  name: my-bridge
spec:
  # ...
  http:
    port: 8080
    cors:
      allowedOrigins: "https://strimzi.io"
      allowedMethods: "GET,POST,PUT,DELETE,OPTIONS,PATCH"
  # ...

13.2.133.2. `KafkaBridgeHttpConfig` スキーマプロパティー

プロパティー	説明
port	サーバーがリッスンするポート。
integer	サーバーがリッスンするポート。
cors	HTTP Bridge の CORS 設定。
`KafkaBridgeHttpCors`	HTTP Bridge の CORS 設定。

13.2.134. `KafkaBridgeHttpCors` スキーマ参照

KafkaBridgeHttpConfig で使用

プロパティー	説明
allowedOrigins	許可されるオリジンのリスト。Java の正規表現を使用できます。
string array	許可されるオリジンのリスト。Java の正規表現を使用できます。
allowedMethods	許可される HTTP メソッドのリスト。
string array	許可される HTTP メソッドのリスト。

13.2.135. `KafkaBridgeConsumerSpec` スキーマ参照

KafkaBridgeSpec で使用

KafkaBridgeConsumerSpec スキーマプロパティーの完全リスト

Kafka Bridge のコンシューマーオプションを鍵として設定します。

値は以下の JSON タイプのいずれかになります。

文字列
数値
ブール値

AMQ Streams で直接管理されるオプションを除き、コンシューマー向けの Apache Kafka 設定ドキュメントに記載されているオプションを指定および設定できます。以下の文字列の 1 つと同じキーまたは以下の文字列の 1 つで始まるキーを持つ設定オプションはすべて禁止されています。

ssl.
sasl.
security.
bootstrap.servers
group.id

禁止されているオプションの 1 つが config プロパティーにある場合、そのオプションは無視され、警告メッセージが Cluster Operator ログファイルに出力されます。その他のオプションはすべて Kafka に渡されます。

重要

config オブジェクトのキーまたは値は Cluster Operator によって検証されません。無効な設定を指定すると、Kafka Bridge クラスターが起動しなかったり、不安定になる可能性があります。Cluster Operator が新しい設定をすべての Kafka Bridge ノードにロールアウトできるように設定を修正します。

Kafka Bridge コンシューマーの設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaBridge
metadata:
  name: my-bridge
spec:
  # ...
  consumer:
    config:
      auto.offset.reset: earliest
      enable.auto.commit: true
      ssl.cipher.suites: "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
      ssl.enabled.protocols: "TLSv1.2"
      ssl.protocol: "TLSv1.2"
      ssl.endpoint.identification.algorithm: HTTPS
    # ...

13.2.135.1. `KafkaBridgeConsumerSpec` スキーマプロパティー

プロパティー	説明
config	ブリッジによって作成されたコンシューマーインスタンスに使用される Kafka コンシューマーの設定。次の接頭辞を持つプロパティーは設定できません: ssl.、bootstrap.servers、group.id、sasl.、security. (次の例外を除く: ssl.endpoint.identification.algorithm、ssl.cipher.suites、ssl.protocol、ssl.enabled.protocols).
map

13.2.136. `KafkaBridgeProducerSpec` スキーマ参照

KafkaBridgeSpec で使用

KafkaBridgeProducerSpec スキーマプロパティーの完全リスト

Kafka Bridge のプロデューサーオプションを鍵として設定します。

値は以下の JSON タイプのいずれかになります。

文字列
数値
ブール値

AMQ Streams で直接管理されるオプションを除き、プロデューサー向けの Apache Kafka 設定ドキュメントに記載されているオプションを指定および設定できます。以下の文字列の 1 つと同じキーまたは以下の文字列の 1 つで始まるキーを持つ設定オプションはすべて禁止されています。

ssl.
sasl.
security.
bootstrap.servers

重要

Kafka Bridge プロデューサーの設定例

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaBridge
metadata:
  name: my-bridge
spec:
  # ...
  producer:
    config:
      acks: 1
      delivery.timeout.ms: 300000
      ssl.cipher.suites: "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
      ssl.enabled.protocols: "TLSv1.2"
      ssl.protocol: "TLSv1.2"
      ssl.endpoint.identification.algorithm: HTTPS
    # ...

13.2.136.1. `KafkaBridgeProducerSpec` スキーマプロパティー

プロパティー	説明
config	ブリッジによって作成されたプロデューサーインスタンスに使用される Kafka プロデューサーの設定。次の接頭辞を持つプロパティーは設定できません: ssl.、bootstrap.servers、sasl.、security. (次の例外を除く: ssl.endpoint.identification.algorithm、ssl.cipher.suites、ssl.protocol、ssl.enabled.protocols).
map

13.2.137. `KafkaBridgeTemplate` スキーマ参照

KafkaBridgeSpec で使用

プロパティー	説明
deployment	Kafka Bridge `Deployment` のテンプレート。
`DeploymentTemplate`	Kafka Bridge `Deployment` のテンプレート。
pod	Kafka Bridge `Pods` のテンプレート。
`PodTemplate`	Kafka Bridge `Pods` のテンプレート。
apiService	Kafka Bridge API `Service` のテンプレート。
`ResourceTemplate`	Kafka Bridge API `Service` のテンプレート。
bridgeContainer	Kafka Bridge コンテナーのテンプレート。
`ContainerTemplate`	Kafka Bridge コンテナーのテンプレート。
podDisruptionBudget	Kafka Bridge `PodDisruptionBudget` のテンプレート。
`PodDisruptionBudgetTemplate`	Kafka Bridge `PodDisruptionBudget` のテンプレート。

13.2.138. `KafkaBridgeStatus` スキーマ参照

KafkaBridge で使用

プロパティー	説明
conditions	ステータス条件の一覧。
`Condition` array	ステータス条件の一覧。
observedGeneration	最後に Operator によって調整された CRD の生成。
integer	最後に Operator によって調整された CRD の生成。
url	外部クライアントアプリケーションが Kafka Bridge にアクセスできる URL。
string	外部クライアントアプリケーションが Kafka Bridge にアクセスできる URL。
labelSelector	このリソースを提供する Pod のラベルセレクター。
string	このリソースを提供する Pod のラベルセレクター。
replicas	このリソースを提供するために現在使用されている Pod の数。
integer	このリソースを提供するために現在使用されている Pod の数。

13.2.139. `KafkaConnector` スキーマ参照

プロパティー	説明
spec	Kafka Connector の仕様。
`KafkaConnectorSpec`	Kafka Connector の仕様。
status	Kafka Connector のステータス。
`KafkaConnectorStatus`	Kafka Connector のステータス。

13.2.140. `KafkaConnectorSpec` スキーマ参照

KafkaConnector で使用

プロパティー	説明
class	Kafka Connector のクラス。
string	Kafka Connector のクラス。
tasksMax	Kafka Connector のタスクの最大数。
integer	Kafka Connector のタスクの最大数。
config	Kafka Connector の設定。次のプロパティーは設定できません: connector.class、tasks.max
map
pause	コネクターを一時停止すべきかどうか。デフォルトは false です。
boolean	コネクターを一時停止すべきかどうか。デフォルトは false です。

13.2.141. `KafkaConnectorStatus` スキーマ参照

KafkaConnector で使用

プロパティー	説明
conditions	ステータス条件の一覧。
`Condition` array	ステータス条件の一覧。
observedGeneration	最後に Operator によって調整された CRD の生成。
integer	最後に Operator によって調整された CRD の生成。
connectorStatus	Kafka Connect REST API によって報告されるコネクターのステータス。
map	Kafka Connect REST API によって報告されるコネクターのステータス。
tasksMax	Kafka Connector のタスクの最大数。
integer	Kafka Connector のタスクの最大数。
topics	Kafka Connector によって使用されるトピックのリスト。
string array	Kafka Connector によって使用されるトピックのリスト。

13.2.142. `KafkaMirrorMaker2` スキーマ参照

プロパティー	説明
spec	Kafka MirrorMaker 2.0 クラスターの仕様。
`KafkaMirrorMaker2Spec`	Kafka MirrorMaker 2.0 クラスターの仕様。
status	Kafka MirrorMaker 2.0 クラスターのステータス。
`KafkaMirrorMaker2Status`	Kafka MirrorMaker 2.0 クラスターのステータス。

13.2.143. `KafkaMirrorMaker2Spec` スキーマ参照

KafkaMirrorMaker2 で使用

プロパティー	説明
version	Kafka Connect のバージョン。デフォルトは 2.7.0 です。バージョンのアップグレードまたはダウングレードに必要なプロセスを理解するには、ユーザードキュメントを参照してください。
string
replicas	Kafka Connect グループの Pod 数。
integer	Kafka Connect グループの Pod 数。
image	Pod の Docker イメージ。
string	Pod の Docker イメージ。
connectCluster	Kafka Connect に使用されるクラスターエイリアス。エイリアスは `spec.clusters` にある一覧のクラスターと一致する必要があります。
string
clusters	ミラーリング用の Kafka クラスター。
`KafkaMirrorMaker2ClusterSpec` array	ミラーリング用の Kafka クラスター。
mirrors	MirrorMaker 2.0 コネクターの設定。
`KafkaMirrorMaker2MirrorSpec` array	MirrorMaker 2.0 コネクターの設定。
resources	CPU とメモリーリソースおよび要求された初期リソースの上限。詳細は、core/v1 resourcerequirements の外部ドキュメントを参照してください。
ResourceRequirements
livenessProbe	Pod の liveness チェック。
`Probe`	Pod の liveness チェック。
readinessProbe	Pod の readiness チェック。
`Probe`	Pod の readiness チェック。
jvmOptions	Pod の JVM オプション。
`JvmOptions`	Pod の JVM オプション。
jmxOptions	JMX オプション。
`KafkaJmxOptions`	JMX オプション。
affinity	`affinity` プロパティーは非推奨となり、`spec.template.pod.affinity` を使用して設定する必要があります。affinity プロパティーは API バージョン `v1beta2` で削除されます。Pod のアフィニティールール。詳細は、core/v1 affinity の外部ドキュメントを参照してください。
Affinity
tolerations	`tolerations` プロパティーは非推奨となり、`spec.template.pod.tolerations` を使用して設定する必要があります。tolerations プロパティーは API バージョン `v1beta2` で削除されます。Pod の許容 (Toleration)。詳細は、core/v1 toleration の外部ドキュメントを参照してください。
Toleration array
logging	Kafka Connect のロギング設定。タイプは、指定のオブジェクト内の `logging.type` プロパティーの値によって異なり、[inline、external] のいずれかでなければなりません。
`InlineLogging`, `ExternalLogging`
metrics	`metrics` プロパティーは非推奨となり、`spec.metricsConfig` を使用して設定する必要があります。metrics プロパティーは API バージョン `v1beta2` で削除されます。Prometheus JMX エクスポーターの設定。この設定の構造に関する詳細は、https://github.com/prometheus/jmx_exporter を参照してください。
map
tracing	Kafka Connect でのトレーシングの設定。タイプは、指定のオブジェクト内の `tracing.type` プロパティーの値によって異なり、[jaeger] の 1 つでなければなりません。
`JaegerTracing`
template	Kafka Connect および Kafka Connect S2I リソースのテンプレート。テンプレートを使用すると、ユーザーは `Deployment`、`Pods`、および `Service` の生成方法を指定できます。
`KafkaConnectTemplate`
externalConfiguration	Secret または ConfigMap から Kafka Connect Pod にデータを渡し、これを使用してコネクターを設定します。
`ExternalConfiguration`
metricsConfig	メトリクスの設定。タイプは、指定のオブジェクト内の `metricsConfig.type` プロパティーの値によって異なり、[jmxPrometheusExporter] の 1 つでなければなりません。
`JmxPrometheusExporterMetrics`

13.2.144. `KafkaMirrorMaker2ClusterSpec` スキーマ参照

KafkaMirrorMaker2Spec で使用

KafkaMirrorMaker2ClusterSpec スキーマプロパティーの完全リスト

ミラーリング用の Kafka クラスターを設定します。

13.2.144.1. `config`

config プロパティーを使用して Kafka オプションを設定します。

標準の Apache Kafka 設定が提供されることがありますが、AMQ Streams によって直接管理されないプロパティーに限定されます。

13.2.144.2. `KafkaMirrorMaker2ClusterSpec` スキーマプロパティー

プロパティー	説明
alias	Kafka クラスターの参照に使用されるエイリアス。
string	Kafka クラスターの参照に使用されるエイリアス。
bootstrapServers	Kafka クラスターへの接続を確立するための `host:port` ペアのコンマ区切りリスト。
string	Kafka クラスターへの接続を確立するための `host:port` ペアのコンマ区切りリスト。
tls	MirrorMaker 2.0 コネクターをクラスターに接続するための TLS 設定。
`KafkaMirrorMaker2Tls`	MirrorMaker 2.0 コネクターをクラスターに接続するための TLS 設定。
authentication	クラスターに接続するための認証設定。タイプは、指定のオブジェクト内の `authentication.type` プロパティーの値によって異なり、[tls、scram-sha-512、plain、oauth] のいずれかでなければなりません。
`KafkaClientAuthenticationTls`, `KafkaClientAuthenticationScramSha512`, `KafkaClientAuthenticationPlain`, `KafkaClientAuthenticationOAuth`
config	MirrorMaker 2.0 クラスターの設定。次の接頭辞を持つプロパティーは設定できません: ssl.、sasl.、security.、listeners、plugin.path、rest.、bootstrap.servers、consumer.interceptor.classes、producer.interceptor.classes (ssl.endpoint.identification.algorithm、ssl.cipher.suites、ssl.protocol、ssl.enabled.protocols を除く)
map

13.2.145. `KafkaMirrorMaker2Tls` スキーマ参照

KafkaMirrorMaker2ClusterSpec で使用

プロパティー	説明
trustedCertificates	TLS 接続の信頼済み証明書。
`CertSecretSource` array	TLS 接続の信頼済み証明書。

13.2.146. `KafkaMirrorMaker2MirrorSpec` スキーマ参照

KafkaMirrorMaker2Spec で使用

プロパティー	説明
sourceCluster	Kafka MirrorMaker 2.0 コネクターによって使用されるソースクラスターのエイリアス。エイリアスは `spec.clusters` にある一覧のクラスターと一致する必要があります。
string
targetCluster	Kafka MirrorMaker 2.0 コネクターによって使用されるターゲットクラスターのエイリアス。エイリアスは `spec.clusters` にある一覧のクラスターと一致する必要があります。
string
sourceConnector	Kafka MirrorMaker 2.0 ソースコネクターの仕様。
`KafkaMirrorMaker2ConnectorSpec`	Kafka MirrorMaker 2.0 ソースコネクターの仕様。
heartbeatConnector	Kafka MirrorMaker 2.0 ハートビートコネクターの仕様。
`KafkaMirrorMaker2ConnectorSpec`	Kafka MirrorMaker 2.0 ハートビートコネクターの仕様。
checkpointConnector	Kafka MirrorMaker 2.0 チェックポイントコネクターの仕様。
`KafkaMirrorMaker2ConnectorSpec`	Kafka MirrorMaker 2.0 チェックポイントコネクターの仕様。
topicsPattern	ミラーリングするトピックに一致する正規表現 (例: "topic1\|topic2\|topic3")。コンマ区切りリストもサポートされます。
string
topicsBlacklistPattern	ミラーリングから除外するトピックに一致する正規表現。コンマ区切りリストもサポートされます。
string	ミラーリングから除外するトピックに一致する正規表現。コンマ区切りリストもサポートされます。
groupsPattern	ミラーリングされるコンシューマーグループに一致する正規表現。コンマ区切りリストもサポートされます。
string	ミラーリングされるコンシューマーグループに一致する正規表現。コンマ区切りリストもサポートされます。
groupsBlacklistPattern	ミラーリングから除外するコンシューマーグループに一致する正規表現。コンマ区切りリストもサポートされます。
string	ミラーリングから除外するコンシューマーグループに一致する正規表現。コンマ区切りリストもサポートされます。

13.2.147. `KafkaMirrorMaker2ConnectorSpec` スキーマ参照

KafkaMirrorMaker2MirrorSpec で使用

プロパティー	説明
tasksMax	Kafka Connector のタスクの最大数。
integer	Kafka Connector のタスクの最大数。
config	Kafka Connector の設定。次のプロパティーは設定できません: connector.class、tasks.max
map
pause	コネクターを一時停止すべきかどうか。デフォルトは false です。
boolean	コネクターを一時停止すべきかどうか。デフォルトは false です。

13.2.148. `KafkaMirrorMaker2Status` スキーマ参照

KafkaMirrorMaker2 で使用

プロパティー	説明
conditions	ステータス条件の一覧。
`Condition` array	ステータス条件の一覧。
observedGeneration	最後に Operator によって調整された CRD の生成。
integer	最後に Operator によって調整された CRD の生成。
url	Kafka Connect コネクターの管理および監視用の REST API エンドポイントの URL。
string	Kafka Connect コネクターの管理および監視用の REST API エンドポイントの URL。
connectorPlugins	この Kafka Connect デプロイメントで使用できるコネクタープラグインの一覧。
`ConnectorPlugin` array	この Kafka Connect デプロイメントで使用できるコネクタープラグインの一覧。
connectors	Kafka Connect REST API によって報告される MirrorMaker 2.0 コネクターステータスの一覧。
map array
labelSelector	このリソースを提供する Pod のラベルセレクター。
string	このリソースを提供する Pod のラベルセレクター。
replicas	このリソースを提供するために現在使用されている Pod の数。
integer	このリソースを提供するために現在使用されている Pod の数。

13.2.149. `KafkaRebalance` スキーマ参照

プロパティー	説明
spec	Kafka のリバランス (再分散) の仕様。
`KafkaRebalanceSpec`	Kafka のリバランス (再分散) の仕様。
status	Kafka のリバランス (再分散) のステータス。
`KafkaRebalanceStatus`	Kafka のリバランス (再分散) のステータス。

13.2.150. `KafkaRebalanceSpec` スキーマ参照

KafkaRebalance で使用

プロパティー	説明
goals	リバランスプロポーザルの生成および実行に使用されるゴールのリスト (優先度順)。サポートされるゴールは https://github.com/linkedin/cruise-control#goals を参照してください。空のゴールリストを指定すると、default.goals Cruise Control 設定パラメーターに宣言されたゴールが使用されます。
string array
skipHardGoalCheck	最適化プロポーザルの生成で、Kafka CR に指定されたハードゴールのスキップを許可するかどうか。これは、これらのハードゴールの一部が原因で分散ソリューションが検索できない場合に便利です。デフォルトは false です。
boolean
excludedTopics	一致するトピックが最適化プロポーザルの計算から除外される正規表現。この正規表現は java.util.regex.Pattern クラスによって解析されます。サポートされる形式の詳細は、このクラスのドキュメントを参照してください。
string
concurrentPartitionMovementsPerBroker	各ブローカーに出入りする継続中であるパーティションレプリカの移動の上限。デフォルトは 5 です。
integer	各ブローカーに出入りする継続中であるパーティションレプリカの移動の上限。デフォルトは 5 です。
concurrentIntraBrokerPartitionMovements	各ブローカー内のディスク間で継続中のパーティションレプリカ移動の上限。デフォルトは 2 です。
integer	各ブローカー内のディスク間で継続中のパーティションレプリカ移動の上限。デフォルトは 2 です。
concurrentLeaderMovements	継続中のパーティションリーダーシップ移動の上限。デフォルトは 1000 です。
integer	継続中のパーティションリーダーシップ移動の上限。デフォルトは 1000 です。
replicationThrottle	レプリカの移動に使用される帯域幅の上限 (バイト/秒単位)。デフォルトでは制限はありません。
integer	レプリカの移動に使用される帯域幅の上限 (バイト/秒単位)。デフォルトでは制限はありません。
replicaMovementStrategies	生成された最適化プロポーザルでのレプリカ移動の実行順序を決定するために使用されるストラテジークラス名のリスト。デフォルトでは、生成された順序でレプリカの移動が実行される BaseReplicaMovementStrategy が使用されます。
string array

13.2.151. `KafkaRebalanceStatus` スキーマ参照

KafkaRebalance で使用

プロパティー	説明
conditions	ステータス条件の一覧。
`Condition` array	ステータス条件の一覧。
observedGeneration	最後に Operator によって調整された CRD の生成。
integer	最後に Operator によって調整された CRD の生成。
sessionId	この KafkaRebalance リソースに関する Cruise Control へのリクエストのセッション識別子。これは、継続中のリバランス操作の状態を追跡するために、Kafka Rebalance operator によって使用されます。
string
optimizationResult	最適化の結果を示す JSON オブジェクト。
map	最適化の結果を示す JSON オブジェクト。

Language and Page Formatting Options

第13章 カスタムリソース API のリファレンス

13.1. 共通の設定プロパティー

13.1.1. replicas

13.1.2. bootstrapServers

13.1.3. ssl

13.1.4. trustedCertificates

13.1.5. resources

13.1.6. image

13.1.7. livenessProbe および readinessProbe ヘルスチェック

13.1.8. metricsConfig

13.1.9. jvmOptions

13.1.10. ガベッジコレクターのロギング

13.2. スキーマプロパティー

13.2.1. Kafka スキーマ参照

13.2.2. KafkaSpec スキーマ参照

13.2.3. KafkaClusterSpec スキーマ参照

13.2.3.1. listeners

13.2.3.2. config

13.2.3.3. brokerRackInitImage

13.2.3.4. logging

13.2.3.5. KafkaClusterSpec スキーマプロパティー

13.2.4. GenericKafkaListener スキーマ参照

13.2.4.1. listeners

13.2.4.2. type

13.2.4.3. port

13.2.4.4. tls

13.2.4.5. authentication

13.2.4.6. networkPolicyPeers

13.2.4.7. GenericKafkaListener スキーマプロパティー

13.2.5. KafkaListenerAuthenticationTls スキーマ参照

13.2.6. KafkaListenerAuthenticationScramSha512 スキーマ参照

13.2.7. KafkaListenerAuthenticationOAuth スキーマ参照

13.2.8. GenericSecretSource スキーマ参照

13.2.9. CertSecretSource スキーマ参照

13.2.10. GenericKafkaListenerConfiguration スキーマ参照

13.2.10.1. brokerCertChainAndKey

13.2.10.2. externalTrafficPolicy

13.2.10.3. loadBalancerSourceRanges

13.2.10.4. class

13.2.10.5. preferredNodePortAddressType

13.2.10.6. useServiceDnsDomain

13.2.10.7. GenericKafkaListenerConfiguration スキーマプロパティー

13.2.11. CertAndKeySecretSource スキーマ参照

13.2.12. GenericKafkaListenerConfigurationBootstrap スキーマ参照

13.2.12.1. alternativeNames

13.2.12.2. host

13.2.12.3. nodePort

13.2.12.4. loadBalancerIP

13.2.12.5. annotations

13.2.12.6. GenericKafkaListenerConfigurationBootstrap スキーマプロパティー

13.2.13. GenericKafkaListenerConfigurationBroker スキーマ参照

13.2.13.1. GenericKafkaListenerConfigurationBroker スキーマプロパティー

13.2.14. KafkaListeners スキーマ参照

13.2.15. KafkaListenerPlain スキーマ参照

13.2.16. KafkaListenerTls スキーマ参照

13.2.17. TlsListenerConfiguration スキーマ参照

13.2.18. KafkaListenerExternalRoute スキーマ参照

13.2.19. RouteListenerOverride スキーマ参照

13.2.20. RouteListenerBootstrapOverride スキーマ参照

13.2.21. RouteListenerBrokerOverride スキーマ参照

13.2.22. KafkaListenerExternalConfiguration スキーマ参照

13.2.23. KafkaListenerExternalLoadBalancer スキーマ参照

13.2.24. LoadBalancerListenerOverride スキーマ参照

13.2.25. LoadBalancerListenerBootstrapOverride スキーマ参照

13.2.26. LoadBalancerListenerBrokerOverride スキーマ参照

13.2.27. KafkaListenerExternalNodePort スキーマ参照

13.2.28. NodePortListenerOverride スキーマ参照

13.2.29. NodePortListenerBootstrapOverride スキーマ参照

13.2.30. NodePortListenerBrokerOverride スキーマ参照

13.2.31. NodePortListenerConfiguration スキーマ参照

13.2.32. KafkaListenerExternalIngress スキーマ参照

13.2.33. IngressListenerConfiguration スキーマ参照

13.2.34. IngressListenerBootstrapConfiguration スキーマ参照

13.2.35. IngressListenerBrokerConfiguration スキーマ参照

13.2.36. EphemeralStorage スキーマ参照

13.2.37. PersistentClaimStorage スキーマ参照

13.2.38. PersistentClaimStorageOverride スキーマ参照

13.2.39. JbodStorage スキーマ参照

13.2.40. KafkaAuthorizationSimple スキーマ参照

第13章カスタムリソース API のリファレンス

13.1.1. `replicas`

13.1.2. `bootstrapServers`

13.1.3. `ssl`

13.1.4. `trustedCertificates`

13.1.5. `resources`

13.1.6. `image`

13.1.7. `livenessProbe` および `readinessProbe` ヘルスチェック

13.1.8. `metricsConfig`

13.1.9. `jvmOptions`

13.2.1. `Kafka` スキーマ参照

13.2.2. `KafkaSpec` スキーマ参照

13.2.3. `KafkaClusterSpec` スキーマ参照

13.2.3.1. `listeners`

13.2.3.2. `config`

13.2.3.3. `brokerRackInitImage`

13.2.3.4. `logging`

13.2.3.5. `KafkaClusterSpec` スキーマプロパティー

13.2.4. `GenericKafkaListener` スキーマ参照

13.2.4.1. `listeners`

13.2.4.2. `type`

13.2.4.3. `port`

13.2.4.4. `tls`

13.2.4.5. `authentication`

13.2.4.6. `networkPolicyPeers`

13.2.4.7. `GenericKafkaListener` スキーマプロパティー

13.2.5. `KafkaListenerAuthenticationTls` スキーマ参照

13.2.6. `KafkaListenerAuthenticationScramSha512` スキーマ参照

13.2.7. `KafkaListenerAuthenticationOAuth` スキーマ参照

13.2.8. `GenericSecretSource` スキーマ参照

13.2.9. `CertSecretSource` スキーマ参照

13.2.10. `GenericKafkaListenerConfiguration` スキーマ参照

13.2.10.1. `brokerCertChainAndKey`

13.2.10.2. `externalTrafficPolicy`

13.2.10.3. `loadBalancerSourceRanges`

13.2.10.4. `class`

13.2.10.5. `preferredNodePortAddressType`

13.2.10.6. `useServiceDnsDomain`

13.2.10.7. `GenericKafkaListenerConfiguration` スキーマプロパティー

13.2.11. `CertAndKeySecretSource` スキーマ参照

13.2.12. `GenericKafkaListenerConfigurationBootstrap` スキーマ参照

13.2.12.1. `alternativeNames`

13.2.12.2. `host`

13.2.12.3. `nodePort`

13.2.12.4. `loadBalancerIP`

13.2.12.5. `annotations`

13.2.12.6. `GenericKafkaListenerConfigurationBootstrap` スキーマプロパティー

13.2.13. `GenericKafkaListenerConfigurationBroker` スキーマ参照

13.2.13.1. `GenericKafkaListenerConfigurationBroker` スキーマプロパティー

13.2.14. `KafkaListeners` スキーマ参照

13.2.15. `KafkaListenerPlain` スキーマ参照

13.2.16. `KafkaListenerTls` スキーマ参照

13.2.17. `TlsListenerConfiguration` スキーマ参照

13.2.18. `KafkaListenerExternalRoute` スキーマ参照

13.2.19. `RouteListenerOverride` スキーマ参照

13.2.20. `RouteListenerBootstrapOverride` スキーマ参照

13.2.21. `RouteListenerBrokerOverride` スキーマ参照

13.2.22. `KafkaListenerExternalConfiguration` スキーマ参照

13.2.23. `KafkaListenerExternalLoadBalancer` スキーマ参照

13.2.24. `LoadBalancerListenerOverride` スキーマ参照

13.2.25. `LoadBalancerListenerBootstrapOverride` スキーマ参照

13.2.26. `LoadBalancerListenerBrokerOverride` スキーマ参照

13.2.27. `KafkaListenerExternalNodePort` スキーマ参照

13.2.28. `NodePortListenerOverride` スキーマ参照

13.2.29. `NodePortListenerBootstrapOverride` スキーマ参照

13.2.30. `NodePortListenerBrokerOverride` スキーマ参照

13.2.31. `NodePortListenerConfiguration` スキーマ参照

13.2.32. `KafkaListenerExternalIngress` スキーマ参照

13.2.33. `IngressListenerConfiguration` スキーマ参照

13.2.34. `IngressListenerBootstrapConfiguration` スキーマ参照

13.2.35. `IngressListenerBrokerConfiguration` スキーマ参照

13.2.36. `EphemeralStorage` スキーマ参照

13.2.37. `PersistentClaimStorage` スキーマ参照

13.2.38. `PersistentClaimStorageOverride` スキーマ参照

13.2.39. `JbodStorage` スキーマ参照

13.2.40. `KafkaAuthorizationSimple` スキーマ参照

13.2.40.1. `superUsers`

13.2.40.2. `KafkaAuthorizationSimple` スキーマプロパティー

13.2.41. `KafkaAuthorizationOpa` スキーマ参照

13.2.41.1. `url`