付録B カスタムリソース API のリファレンス
B.1. Kafka スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| spec | Kafka および ZooKeeper クラスター、Topic Operator の仕様。 |
| status | Kafka および ZooKeeper クラスター、Topic Operator のステータス。 |
B.2. KafkaSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
Kafka で使用
| プロパティー | 説明 |
|---|---|
| kafka | Kafka クラスターの設定。 |
| zookeeper | ZooKeeper クラスターの設定。 |
| topicOperator |
|
| entityOperator | Entity Operator の設定。 |
| clusterCa | クラスター認証局の設定。 |
| clientsCa | クライアント認証局の設定。 |
| kafkaExporter | Kafka Exporter の設定。Kafka Exporter は追加のメトリクスを提供できます (例: トピック/パーティションでのコンシューマーグループのラグなど)。 |
| maintenanceTimeWindows | メンテナンスタスク (証明書の更新) 用の時間枠の一覧。それぞれの時間枠は、cron 式で定義されます。 |
| string array |
B.3. KafkaClusterSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaSpec で使用
| プロパティー | 説明 |
|---|---|
| replicas | クラスター内の Pod 数。 |
| integer | |
| image |
Pod の Docker イメージ。デフォルト値は、設定した |
| string | |
| storage |
ストレージの設定 (ディスク)。更新はできません。タイプは、指定のオブジェクト内の |
| listeners | Kafka ブローカーのリスナーを設定します。 |
| authorization |
Kafka ブローカーの承認設定。タイプは、指定のオブジェクト内の |
| config | Kafka ブローカーの設定。次の接頭辞を持つプロパティーは設定できません: 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 |
| map | |
| rack |
|
| brokerRackInitImage |
|
| string | |
| affinity |
|
| tolerations |
|
| Toleration array | |
| livenessProbe | Pod の liveness チェック。 |
| readinessProbe | Pod の readiness チェック。 |
| jvmOptions | Pod の JVM オプション。 |
| jmxOptions | Kafka ブローカーの JMX オプション。 |
| resources | 予約する CPU およびメモリーリソース。 |
| metrics | Prometheus JMX エクスポーターの設定。この設定の構造に関する詳細は、https://github.com/prometheus/jmx_exporter を参照してください。 |
| map | |
| logging |
Kafka のロギング設定。タイプは、指定のオブジェクト内の |
| tlsSidecar | TLS サイドカーの設定。 |
| template |
Kafka クラスターリソースのテンプレート。テンプレートを使用すると、ユーザーは |
| version | Kafka ブローカーのバージョン。デフォルトは 2.4.0 です。バージョンのアップグレードまたはダウングレードに必要なプロセスを理解するには、ユーザードキュメントを参照してください。 |
| string |
B.4. EphemeralStorage スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
JbodStorage、KafkaClusterSpec、ZookeeperClusterSpec で使用
type プロパティーは、EphemeralStorage タイプを使用する際に PersistentClaimStorage タイプと区別する識別子です。EphemeralStorage タイプには ephemeral の値が必要です。
| プロパティー | 説明 |
|---|---|
| id | ストレージ ID 番号。これは、'jbod' タイプのストレージで定義されるストレージボリュームのみで必須です。 |
| integer | |
| sizeLimit | type=ephemeral の場合、この EmptyDir ボリュームに必要なローカルストレージの合計容量を定義します (例: 1Gi)。 |
| string | |
| type |
|
| string |
B.5. PersistentClaimStorage スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
JbodStorage、KafkaClusterSpec、ZookeeperClusterSpec で使用
type プロパティーは、PersistentClaimStorage タイプを使用する際に EphemeralStorage タイプと区別する識別子です。PersistentClaimStorage タイプには persistent-claim の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string | |
| size | type=persistent-claim の場合、永続ボリューム要求のサイズを定義します (例: 1Gi).。type=persistent-claim の場合には必須です。 |
| string | |
| selector | 使用する特定の永続ボリュームを指定します。このようなボリュームを選択するラベルを表す key:value ペアが含まれます。 |
| map | |
| deleteClaim | クラスターのアンデプロイ時に永続ボリューム要求を削除する必要があるかどうかを指定します。 |
| boolean | |
| class | 動的ボリュームの割り当てに使用するストレージクラス。 |
| string | |
| id | ストレージ ID 番号。これは、'jbod' タイプのストレージで定義されるストレージボリュームのみで必須です。 |
| integer | |
| overrides |
個々のブローカーを上書きします。 |
B.6. PersistentClaimStorageOverride スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| class | このブローカーの動的ボリュームの割り当てに使用するストレージクラス。 |
| string | |
| broker | Kafka ブローカーの ID (ブローカー ID)。 |
| integer |
B.7. JbodStorage スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaClusterSpec で使用
type プロパティーは、JbodStorage タイプを使用する際に EphemeralStorage および PersistentClaimStorage タイプと区別する識別子です。JbodStorage タイプには jbod の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string | |
| volumes | JBOD ディスクアレイを表すストレージオブジェクトとしてのボリュームの一覧。 |
B.8. KafkaListeners スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaClusterSpec で使用
| プロパティー | 説明 |
|---|---|
| plain | ポート 9092 でプレーンリスナーを設定します。 |
| tls | ポート 9093 で TLS リスナーを設定します。 |
| external |
ポート 9094 で外部リスナーを設定します。タイプは、指定のオブジェクト内の |
|
|
B.9. KafkaListenerPlain スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListeners で使用
| プロパティー | 説明 |
|---|---|
| authentication |
このリスナーの認証設定。このリスナーは TLS トランスポートを使用しないため、 |
|
| |
| networkPolicyPeers | このリスナーに接続できるピアの一覧。この一覧のピアは、論理演算子 OR を使用して組み合わせます。このフィールドが空であるか、または存在しない場合、このリスナーのすべてのコネクションが許可されます。このフィールドが存在し、1 つ以上の項目が含まれる場合、リスナーはこの一覧の少なくとも 1 つの項目と一致するトラフィックのみを許可します。外部のドキュメント networking.k8s.io/v1 networkpolicypeer を参照してください。 |
| NetworkPolicyPeer array |
B.10. KafkaListenerAuthenticationTls スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListenerExternalIngress、KafkaListenerExternalLoadBalancer、KafkaListenerExternalNodePort、KafkaListenerExternalRoute、KafkaListenerPlain、KafkaListenerTls で使用
type プロパティーは、KafkaListenerAuthenticationTls タイプを使用する際に KafkaListenerAuthenticationScramSha512 および KafkaListenerAuthenticationOAuth タイプと区別する識別子です。KafkaListenerAuthenticationTls タイプには tls の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string |
B.11. KafkaListenerAuthenticationScramSha512 スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListenerExternalIngress、KafkaListenerExternalLoadBalancer、KafkaListenerExternalNodePort、KafkaListenerExternalRoute、KafkaListenerPlain、KafkaListenerTls で使用
type プロパティーは、KafkaListenerAuthenticationScramSha512 タイプを使用する際に KafkaListenerAuthenticationTls および KafkaListenerAuthenticationOAuth タイプと区別する識別子です。KafkaListenerAuthenticationScramSha512 タイプには scram-sha-512 の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string |
B.12. KafkaListenerAuthenticationOAuth スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListenerExternalIngress、KafkaListenerExternalLoadBalancer、KafkaListenerExternalNodePort、KafkaListenerExternalRoute、KafkaListenerPlain、KafkaListenerTls で使用
type プロパティーは、KafkaListenerAuthenticationOAuth タイプを使用する際に KafkaListenerAuthenticationTls および KafkaListenerAuthenticationScramSha512 タイプと区別する識別子です。KafkaListenerAuthenticationOAuth タイプには oauth の値が必要です。
| プロパティー | 説明 |
|---|---|
| accessTokenIsJwt |
アクセストークンを JWT として処理すべきかどうかを設定します。承認サーバーが不透明なトークンを返す場合は |
| boolean | |
| checkAccessTokenType |
アクセストークンタイプのチェックを行うべきかどうかを設定します。承認サーバーの JWT トークンに 'typ' 要求が含まれない場合は、 |
| boolean | |
| clientId | Kafka ブローカーは、OAuth クライアント ID を使用して承認サーバーに対して認証し、イントロスペクションエンドポイント URI を使用することができます。 |
| string | |
| clientSecret | OAuth クライアントシークレットが含まれる OpenShift シークレットへのリンク。Kafka ブローカーは、OAuth クライアントシークレットを使用して承認サーバーに対して認証し、イントロスペクションエンドポイント URI を使用することができます。 |
| disableTlsHostnameVerification |
TLS ホスト名の検証を有効または無効にします。デフォルト値は |
| boolean | |
| enableECDSA |
BouncyCastle 暗号プロバイダーをインストールして、ECDSA サポートを有効または無効にします。デフォルト値は |
| boolean | |
| introspectionEndpointUri | 不透明な JWT 以外のトークンの検証に使用できるトークンイントロスペクションエンドポイントの URI。 |
| string | |
| jwksEndpointUri | ローカルの JWT 検証に使用できる JWKS 証明書エンドポイントの URI。 |
| string | |
| jwksExpirySeconds |
JWKS 証明書が有効とみなされる頻度を設定します。期限切れの間隔は、 |
| integer | |
| jwksRefreshSeconds |
JWKS 証明書が更新される頻度を設定します。更新間隔は、 |
| integer | |
| tlsTrustedCertificates | OAuth サーバーへの TLS 接続の信頼済み証明書。 |
|
| |
| type |
|
| string | |
| userNameClaim |
ユーザープリンシパルとして使用される認証トークンからの要求の名前。デフォルトは |
| string | |
| validIssuerUri | 認証に使用されるトークン発行者の URI。 |
| string |
B.13. GenericSecretSource スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaClientAuthenticationOAuth、KafkaListenerAuthenticationOAuth で使用
| プロパティー | 説明 |
|---|---|
| key | OpenShift シークレットでシークレット値が保存されるキー。 |
| string | |
| secretName | シークレット値が含まれる OpenShift シークレットの名前。 |
| string |
B.14. CertSecretSource スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaAuthorizationKeycloak、KafkaBridgeTls、KafkaClientAuthenticationOAuth、KafkaConnectTls、KafkaListenerAuthenticationOAuth、KafkaMirrorMaker2Tls、KafkaMirrorMakerTls で使用
| プロパティー | 説明 |
|---|---|
| certificate | Secret のファイル証明書の名前。 |
| string | |
| secretName | 証明書が含まれる Secret の名前。 |
| string |
B.15. KafkaListenerTls スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListeners で使用
| プロパティー | 説明 |
|---|---|
| authentication |
このリスナーの認証設定。タイプは、指定のオブジェクト内の |
|
| |
| configuration | TLS リスナーの設定。 |
| networkPolicyPeers | このリスナーに接続できるピアの一覧。この一覧のピアは、論理演算子 OR を使用して組み合わせます。このフィールドが空であるか、または存在しない場合、このリスナーのすべてのコネクションが許可されます。このフィールドが存在し、1 つ以上の項目が含まれる場合、リスナーはこの一覧の少なくとも 1 つの項目と一致するトラフィックのみを許可します。外部のドキュメント networking.k8s.io/v1 networkpolicypeer を参照してください。 |
| NetworkPolicyPeer array |
B.16. TlsListenerConfiguration スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListenerTls で使用
| プロパティー | 説明 |
|---|---|
| brokerCertChainAndKey |
証明書と秘密鍵のペアを保持する |
B.17. CertAndKeySecretSource スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
IngressListenerConfiguration、KafkaClientAuthenticationTls、KafkaListenerExternalConfiguration、NodePortListenerConfiguration、TlsListenerConfiguration で使用
| プロパティー | 説明 |
|---|---|
| certificate | Secret のファイル証明書の名前。 |
| string | |
| key | Secret の秘密鍵の名前。 |
| string | |
| secretName | 証明書が含まれる Secret の名前。 |
| string |
B.18. KafkaListenerExternalRoute スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListeners で使用
type プロパティーは、KafkaListenerExternalRoute タイプを使用する際に KafkaListenerExternalLoadBalancer、KafkaListenerExternalNodePort、および KafkaListenerExternalIngress タイプと区別する識別子です。KafkaListenerExternalRoute タイプには route の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string | |
| authentication |
Kafka ブローカーの認証の設定タイプは、指定のオブジェクト内の |
|
| |
| overrides | 外部ブートストラップサービスおよびブローカーサービス、ならびに外部にアドバタイズされたアドレスの上書き。 |
| configuration | 外部リスナーの設定。 |
| networkPolicyPeers | このリスナーに接続できるピアの一覧。この一覧のピアは、論理演算子 OR を使用して組み合わせます。このフィールドが空であるか、または存在しない場合、このリスナーのすべてのコネクションが許可されます。このフィールドが存在し、1 つ以上の項目が含まれる場合、リスナーはこの一覧の少なくとも 1 つの項目と一致するトラフィックのみを許可します。外部のドキュメント networking.k8s.io/v1 networkpolicypeer を参照してください。 |
| NetworkPolicyPeer array |
B.19. RouteListenerOverride スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListenerExternalRoute で使用
| プロパティー | 説明 |
|---|---|
| bootstrap | 外部ブートストラップサービスの設定。 |
| brokers | 外部ブローカーサービスの設定。 |
B.20. RouteListenerBootstrapOverride スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| address | ブートストラップサービスの追加のアドレス名。このアドレスは、TLS 証明書のサブジェクトの別名の一覧に追加されます。 |
| string | |
| host |
ブートストラップルートのホスト。このフィールドは OpenShift Route の |
| string |
B.21. RouteListenerBrokerOverride スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| broker | Kafka ブローカーの ID (ブローカー ID)。 |
| integer | |
| advertisedHost |
ブローカーの |
| string | |
| advertisedPort |
ブローカーの |
| integer | |
| host |
ブローカールートのホスト。このフィールドは OpenShift Route の |
| string |
B.22. KafkaListenerExternalConfiguration スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListenerExternalLoadBalancer、KafkaListenerExternalRoute で使用
| プロパティー | 説明 |
|---|---|
| brokerCertChainAndKey |
証明書と秘密鍵のペアを保持する |
B.23. KafkaListenerExternalLoadBalancer スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListeners で使用
type プロパティーは、KafkaListenerExternalLoadBalancer タイプを使用する際に KafkaListenerExternalRoute、KafkaListenerExternalNodePort、および KafkaListenerExternalIngress タイプと区別する識別子です。KafkaListenerExternalLoadBalancer タイプには loadbalancer の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string | |
| authentication |
Kafka ブローカーの認証の設定タイプは、指定のオブジェクト内の |
|
| |
| overrides | 外部ブートストラップサービスおよびブローカーサービス、ならびに外部にアドバタイズされたアドレスの上書き。 |
| configuration | 外部リスナーの設定。 |
| networkPolicyPeers | このリスナーに接続できるピアの一覧。この一覧のピアは、論理演算子 OR を使用して組み合わせます。このフィールドが空であるか、または存在しない場合、このリスナーのすべてのコネクションが許可されます。このフィールドが存在し、1 つ以上の項目が含まれる場合、リスナーはこの一覧の少なくとも 1 つの項目と一致するトラフィックのみを許可します。外部のドキュメント networking.k8s.io/v1 networkpolicypeer を参照してください。 |
| NetworkPolicyPeer array | |
| tls |
リスナーで TLS による暗号化を有効にします。有効な TLS 暗号化の場合、デフォルトで |
| boolean |
B.24. LoadBalancerListenerOverride スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListenerExternalLoadBalancer で使用
| プロパティー | 説明 |
|---|---|
| bootstrap | 外部ブートストラップサービスの設定。 |
| brokers | 外部ブローカーサービスの設定。 |
B.25. LoadBalancerListenerBootstrapOverride スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
LoadBalancerListenerOverride で使用
| プロパティー | 説明 |
|---|---|
| address | ブートストラップサービスの追加のアドレス名。このアドレスは、TLS 証明書のサブジェクトの別名の一覧に追加されます。 |
| string | |
| dnsAnnotations |
|
| map | |
| loadBalancerIP |
ロードバランサーは、このフィールドに指定された IP アドレスで要求されます。この機能は、ロードバランサーの作成時に、基礎となるクラウドプロバイダーが |
| string |
B.26. LoadBalancerListenerBrokerOverride スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
LoadBalancerListenerOverride で使用
| プロパティー | 説明 |
|---|---|
| broker | Kafka ブローカーの ID (ブローカー ID)。 |
| integer | |
| advertisedHost |
ブローカーの |
| string | |
| advertisedPort |
ブローカーの |
| integer | |
| dnsAnnotations |
個別のブローカーの |
| map | |
| loadBalancerIP |
ロードバランサーは、このフィールドに指定された IP アドレスで要求されます。この機能は、ロードバランサーの作成時に、基礎となるクラウドプロバイダーが |
| string |
B.27. KafkaListenerExternalNodePort スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListeners で使用
type プロパティーは、KafkaListenerExternalNodePort タイプを使用する際に KafkaListenerExternalRoute、KafkaListenerExternalLoadBalancer、および KafkaListenerExternalIngress タイプと区別する識別子です。KafkaListenerExternalNodePort タイプには nodeport の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string | |
| authentication |
Kafka ブローカーの認証の設定タイプは、指定のオブジェクト内の |
|
| |
| overrides | 外部ブートストラップサービスおよびブローカーサービス、ならびに外部にアドバタイズされたアドレスの上書き。 |
| configuration | 外部リスナーの設定。 |
| networkPolicyPeers | このリスナーに接続できるピアの一覧。この一覧のピアは、論理演算子 OR を使用して組み合わせます。このフィールドが空であるか、または存在しない場合、このリスナーのすべてのコネクションが許可されます。このフィールドが存在し、1 つ以上の項目が含まれる場合、リスナーはこの一覧の少なくとも 1 つの項目と一致するトラフィックのみを許可します。外部のドキュメント networking.k8s.io/v1 networkpolicypeer を参照してください。 |
| NetworkPolicyPeer array | |
| tls |
リスナーで TLS による暗号化を有効にします。有効な TLS 暗号化の場合、デフォルトで |
| boolean |
B.28. NodePortListenerOverride スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListenerExternalNodePort で使用
| プロパティー | 説明 |
|---|---|
| bootstrap | 外部ブートストラップサービスの設定。 |
| brokers | 外部ブローカーサービスの設定。 |
B.29. NodePortListenerBootstrapOverride スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| address | ブートストラップサービスの追加のアドレス名。このアドレスは、TLS 証明書のサブジェクトの別名の一覧に追加されます。 |
| string | |
| dnsAnnotations |
|
| map | |
| nodePort | ブートストラップサービスのノードポート。 |
| integer |
B.30. NodePortListenerBrokerOverride スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| broker | Kafka ブローカーの ID (ブローカー ID)。 |
| integer | |
| advertisedHost |
ブローカーの |
| string | |
| advertisedPort |
ブローカーの |
| integer | |
| nodePort | ブローカーサービスのノードポート。 |
| integer | |
| dnsAnnotations |
個別のブローカーの |
| map |
B.31. NodePortListenerConfiguration スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListenerExternalNodePort で使用
| プロパティー | 説明 |
|---|---|
| brokerCertChainAndKey |
証明書と秘密鍵のペアを保持する |
| preferredAddressType |
ノードアドレスとして使用するアドレスタイプを定義します。利用可能なタイプは、 このフィールドは、優先タイプとして使用され、最初にチェックされるアドレスタイプの選択に使用できます。このアドレスタイプのアドレスが見つからない場合は、デフォルトの順序で他のタイプが使用されます。 |
| string ([ExternalDNS、ExternalIP、Hostname、InternalIP、InternalDNS] のいずれか) |
B.32. KafkaListenerExternalIngress スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListeners で使用
type プロパティーは、KafkaListenerExternalIngress タイプを使用する際に KafkaListenerExternalRoute、KafkaListenerExternalLoadBalancer、および KafkaListenerExternalNodePort タイプと区別する識別子です。KafkaListenerExternalIngress タイプには ingress の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string | |
| authentication |
Kafka ブローカーの認証の設定タイプは、指定のオブジェクト内の |
|
| |
| class |
使用する |
| string | |
| configuration | 外部リスナーの設定。 |
| networkPolicyPeers | このリスナーに接続できるピアの一覧。この一覧のピアは、論理演算子 OR を使用して組み合わせます。このフィールドが空であるか、または存在しない場合、このリスナーのすべてのコネクションが許可されます。このフィールドが存在し、1 つ以上の項目が含まれる場合、リスナーはこの一覧の少なくとも 1 つの項目と一致するトラフィックのみを許可します。外部のドキュメント networking.k8s.io/v1 networkpolicypeer を参照してください。 |
| NetworkPolicyPeer array |
B.33. IngressListenerConfiguration スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaListenerExternalIngress で使用
| プロパティー | 説明 |
|---|---|
| bootstrap | 外部ブートストラップ Ingress の設定。 |
| brokers | 外部ブローカー Ingress の設定。 |
| brokerCertChainAndKey |
証明書と秘密鍵のペアを保持する |
B.34. IngressListenerBootstrapConfiguration スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
IngressListenerConfiguration で使用
| プロパティー | 説明 |
|---|---|
| address | ブートストラップサービスの追加のアドレス名。このアドレスは、TLS 証明書のサブジェクトの別名の一覧に追加されます。 |
| string | |
| dnsAnnotations |
|
| map | |
| host | ブートストラップルートのホスト。このフィールドは Ingress リソースで使用されます。 |
| string |
B.35. IngressListenerBrokerConfiguration スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
IngressListenerConfiguration で使用
| プロパティー | 説明 |
|---|---|
| broker | Kafka ブローカーの ID (ブローカー ID)。 |
| integer | |
| advertisedHost |
ブローカーの |
| string | |
| advertisedPort |
ブローカーの |
| integer | |
| host | ブローカー Ingress のホスト。このフィールドは Ingress リソースで使用されます。 |
| string | |
| dnsAnnotations |
個別のブローカーの |
| map |
B.36. KafkaAuthorizationSimple スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaClusterSpec で使用
type プロパティーは、KafkaAuthorizationSimple タイプの使用を KafkaAuthorizationKeycloak と区別する識別子です。KafkaAuthorizationSimple タイプには simple の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string | |
| superUsers | スーパーユーザーの一覧。無制限のアクセス権を取得する必要のあるユーザープリンシパルの一覧が含まれなければなりません。 |
| string array |
B.37. KafkaAuthorizationKeycloak スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaClusterSpec で使用
type プロパティーは、KafkaAuthorizationKeycloak タイプの使用を KafkaAuthorizationSimple と区別する識別子です。KafkaAuthorizationKeycloak タイプには keycloak の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string | |
| clientId | Kafka クライアントが OAuth サーバーに対する認証に使用し、トークンエンドポイント URI を使用することができる OAuth クライアント ID。 |
| string | |
| tokenEndpointUri | 承認サーバートークンエンドポイント URI。 |
| string | |
| tlsTrustedCertificates | OAuth サーバーへの TLS 接続の信頼済み証明書。 |
|
| |
| disableTlsHostnameVerification |
TLS ホスト名の検証を有効または無効にします。デフォルト値は |
| boolean | |
| delegateToKafkaAcls |
Keycloak Authorization Services ポリシーにより DENIED となった場合に、承認の決定を 'Simple' オーソライザーに委譲すべきかどうか。デフォルト値は |
| boolean | |
| superUsers | スーパーユーザーの一覧。無制限のアクセス権を取得する必要のあるユーザープリンシパルの一覧が含まれなければなりません。 |
| string array |
B.38. Rack スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaClusterSpec で使用
| プロパティー | 説明 |
|---|---|
| topologyKey |
OpenShift クラスターノードに割り当てられたラベルに一致するキー。ラベルの値を使用して、ブローカーの |
| string |
B.39. Probe スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
EntityTopicOperatorSpec、EntityUserOperatorSpec、KafkaBridgeSpec、KafkaClusterSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaExporterSpec、KafkaMirrorMaker2Spec、KafkaMirrorMakerSpec、TlsSidecar、TopicOperatorSpec、ZookeeperClusterSpec で使用
| プロパティー | 説明 |
|---|---|
| failureThreshold | 正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。 |
| integer | |
| initialDelaySeconds | 最初に健全性をチェックするまでの初期の遅延。 |
| integer | |
| periodSeconds | プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。 |
| integer | |
| successThreshold | 失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。liveness は 1 でなければなりません。最小値は 1 です。 |
| integer | |
| timeoutSeconds | ヘルスチェック試行のタイムアウト。 |
| integer |
B.40. JvmOptions スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridgeSpec、KafkaClusterSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2Spec、KafkaMirrorMakerSpec、ZookeeperClusterSpec で使用
| プロパティー | 説明 |
|---|---|
| -XX | JVM への -XX オプションのマップ。 |
| map | |
| -Xms | JVM への -Xms オプション。 |
| string | |
| -Xmx | JVM への -Xmx オプション。 |
| string | |
| gcLoggingEnabled | ガベージコレクションのロギングが有効かどうかを指定します。デフォルトは false です。 |
| boolean | |
| javaSystemProperties |
|
|
|
B.41. SystemProperty スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
JvmOptions で使用
| プロパティー | 説明 |
|---|---|
| name | システムプロパティー名。 |
| string | |
| value | システムプロパティーの値。 |
| string |
B.42. KafkaJmxOptions スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaClusterSpec で使用
| プロパティー | 説明 |
|---|---|
| authentication |
Kafka JMX ポートに接続するための認証設定。タイプは、指定のオブジェクト内の |
B.43. KafkaJmxAuthenticationPassword スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaJmxOptions で使用
type プロパティーは、KafkaJmxAuthenticationPassword タイプを使用する際に、今後追加される可能性のある他のサブタイプと区別する識別子です。KafkaJmxAuthenticationPassword タイプには password の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string |
B.44. ResourceRequirements スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
EntityTopicOperatorSpec、EntityUserOperatorSpec、KafkaBridgeSpec、KafkaClusterSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaExporterSpec、KafkaMirrorMaker2Spec、KafkaMirrorMakerSpec、TlsSidecar、TopicOperatorSpec、ZookeeperClusterSpec で使用
| プロパティー | 説明 |
|---|---|
| limits | |
| map | |
| requests | |
| map |
B.45. InlineLogging スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
EntityTopicOperatorSpec、EntityUserOperatorSpec、KafkaBridgeSpec、KafkaClusterSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2Spec、KafkaMirrorMakerSpec、TopicOperatorSpec、ZookeeperClusterSpec で使用
type プロパティーは、InlineLogging タイプの使用を ExternalLogging と区別する識別子です。InlineLogging タイプには inline の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string | |
| loggers | ロガー名からロガーレベルへのマップ。 |
| map |
B.46. ExternalLogging スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
EntityTopicOperatorSpec、EntityUserOperatorSpec、KafkaBridgeSpec、KafkaClusterSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2Spec、KafkaMirrorMakerSpec、TopicOperatorSpec、ZookeeperClusterSpec で使用
type プロパティーは、ExternalLogging タイプを使用する際に InlineLogging タイプと区別する識別子です。ExternalLogging タイプには external の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string | |
| name |
ロギング設定の取得元となる |
| string |
B.47. TlsSidecar スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
EntityOperatorSpec、KafkaClusterSpec、TopicOperatorSpec、ZookeeperClusterSpec で使用
| プロパティー | 説明 |
|---|---|
| image | コンテナーの Docker イメージ。 |
| string | |
| livenessProbe | Pod の liveness チェック。 |
| logLevel |
TLS サイドカーのログレベル。デフォルト値は |
| string ([emerg、debug、crit、err、alert、warning、notice、info] のいずれか) | |
| readinessProbe | Pod の readiness チェック。 |
| resources | 予約する CPU およびメモリーリソース。 |
B.48. KafkaClusterTemplate スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaClusterSpec で使用
| プロパティー | 説明 |
|---|---|
| statefulset |
Kafka |
| pod |
Kafka |
| bootstrapService |
Kafka ブートストラップ |
| brokersService |
Kafka ブローカー |
| externalBootstrapService |
Kafka 外部ブートストラップ |
| perPodService |
OpenShift の外部からアクセスするために使用される Kafka の Pod ごとの |
| externalBootstrapRoute |
Kafka 外部ブートストラップ |
| perPodRoute |
OpenShift の外部からアクセスするために使用される Kafka の Pod ごとの |
| externalBootstrapIngress |
Kafka 外部ブートストラップ |
| perPodIngress |
OpenShift の外部からアクセスするために使用される Kafka の Pod ごとの |
| persistentVolumeClaim |
すべての Kafka |
| podDisruptionBudget |
Kafka |
| kafkaContainer | Kafka ブローカーコンテナーのテンプレート。 |
| tlsSidecarContainer | Kafka ブローカー TLS サイドカーコンテナーのテンプレート。 |
| initContainer | Kafka init コンテナーのテンプレート。 |
B.49. StatefulSetTemplate スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaClusterTemplate、ZookeeperClusterTemplate で使用
| プロパティー | 説明 |
|---|---|
| metadata | リソースに適用する必要のあるメタデータ。 |
| podManagementPolicy |
この StatefulSet に使用される PodManagementPolicy。有効な値は |
| string ([OrderedReady、Parallel] のいずれか) |
B.50. MetadataTemplate スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
ExternalServiceTemplate、PodDisruptionBudgetTemplate、PodTemplate、ResourceTemplate、StatefulSetTemplate で使用
| プロパティー | 説明 |
|---|---|
| labels |
リソーステンプレートに追加する必要のあるラベル。 |
| map | |
| annotations |
リソーステンプレートに追加する必要のあるアノテーション。 |
| map |
B.51. PodTemplate スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
EntityOperatorTemplate、KafkaBridgeTemplate、KafkaClusterTemplate、KafkaConnectTemplate、KafkaExporterTemplate、KafkaMirrorMakerTemplate、ZookeeperClusterTemplate で使用
| プロパティー | 説明 |
|---|---|
| metadata | リソースに適用済みのメタデータ。 |
| imagePullSecrets | この Pod で使用されるイメージのプルに使用する同じ namespace のシークレットへの参照の一覧です。外部のドキュメント core/v1 localobjectreference を参照してください。 |
| LocalObjectReference array | |
| securityContext | Pod レベルのセキュリティー属性と共通のコンテナー設定を設定します。外部のドキュメント core/v1 podsecuritycontext を参照してください。 |
| terminationGracePeriodSeconds | 猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、予想されるプロセスのクリーンアップ時間よりも長く設定します。値は負の数ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。デフォルトは 30 秒です。 |
| integer | |
| affinity | Pod のアフィニティールール。外部のドキュメント core/v1 affinity を参照してください。 |
| priorityClassName | これらの Pod を割り当てる優先順位クラスの名前。 |
| string | |
| schedulerName |
この |
| string | |
| tolerations | Pod の許容 (Toleration)。外部のドキュメント core/v1 toleration を参照してください。 |
| Toleration array |
B.52. ResourceTemplate スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
EntityOperatorTemplate、KafkaBridgeTemplate、KafkaClusterTemplate、KafkaConnectTemplate、KafkaExporterTemplate、KafkaMirrorMakerTemplate、ZookeeperClusterTemplate で使用
| プロパティー | 説明 |
|---|---|
| metadata | リソースに適用する必要のあるメタデータ。 |
B.53. ExternalServiceTemplate スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| metadata | リソースに適用する必要のあるメタデータ。 |
| externalTrafficPolicy |
サービスによって外部トラフィックがローカルノードのエンドポイントまたはクラスター全体のエンドポイントにルーティングされるかどうかを指定します。 |
| string ([Local、Cluster] のいずれか) | |
| loadBalancerSourceRanges |
クライアントがロードバランサータイプのリスナーに接続できる CIDR 形式による範囲 (例: |
| string array |
B.54. PodDisruptionBudgetTemplate スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridgeTemplate、KafkaClusterTemplate、KafkaConnectTemplate、KafkaMirrorMakerTemplate、ZookeeperClusterTemplate で使用
| プロパティー | 説明 |
|---|---|
| metadata |
|
| maxUnavailable |
自動 Pod エビクションを許可するための利用不可能な Pod の最大数。Pod エビクションは、 |
| integer |
B.55. ContainerTemplate スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
EntityOperatorTemplate、KafkaBridgeTemplate、KafkaClusterTemplate、KafkaConnectTemplate、KafkaExporterTemplate、KafkaMirrorMakerTemplate、ZookeeperClusterTemplate で使用
| プロパティー | 説明 |
|---|---|
| env | コンテナーに適用する必要のある環境変数。 |
|
|
B.56. ContainerEnvVar スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| name | 環境変数のキー。 |
| string | |
| value | 環境変数の値。 |
| string |
B.57. ZookeeperClusterSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaSpec で使用
| プロパティー | 説明 |
|---|---|
| replicas | クラスター内の Pod 数。 |
| integer | |
| image | Pod の Docker イメージ。 |
| string | |
| storage |
ストレージの設定 (ディスク)。更新はできません。タイプは、指定のオブジェクト内の |
| config | ZooKeeper ブローカーの設定。次の接頭辞を持つプロパティーは設定できません: server.、dataDir、dataLogDir、clientPort、authProvider、quorum.auth、requireClientAuthScheme |
| map | |
| affinity |
|
| tolerations |
|
| Toleration array | |
| livenessProbe | Pod の liveness チェック。 |
| readinessProbe | Pod の readiness チェック。 |
| jvmOptions | Pod の JVM オプション。 |
| resources | 予約する CPU およびメモリーリソース。 |
| metrics | Prometheus JMX エクスポーターの設定。この設定の構造に関する詳細は、https://github.com/prometheus/jmx_exporter を参照してください。 |
| map | |
| logging |
ZooKeeper のロギング設定。タイプは、指定のオブジェクト内の |
| tlsSidecar | TLS サイドカーの設定。 |
| template |
ZooKeeper クラスターリソースのテンプレート。テンプレートを使用すると、ユーザーは |
B.58. ZookeeperClusterTemplate スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| statefulset |
ZooKeeper |
| pod |
ZooKeeper |
| clientService |
ZooKeeper クライアント |
| nodesService |
ZooKeeper ノード |
| persistentVolumeClaim |
すべての ZooKeeper |
| podDisruptionBudget |
ZooKeeper |
| zookeeperContainer | ZooKeeper コンテナーのテンプレート。 |
| tlsSidecarContainer | Kafka ブローカー TLS サイドカーコンテナーのテンプレート。 |
B.59. TopicOperatorSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaSpec で使用
| プロパティー | 説明 |
|---|---|
| watchedNamespace | Topic Operator が監視する必要のある namespace。 |
| string | |
| image | Topic Operator に使用するイメージ。 |
| string | |
| reconciliationIntervalSeconds | 定期的な調整の間隔。 |
| integer | |
| zookeeperSessionTimeoutSeconds | ZooKeeper セッションのタイムアウト。 |
| integer | |
| affinity | Pod のアフィニティールール。外部のドキュメント core/v1 affinity を参照してください。 |
| resources | 予約する CPU およびメモリーリソース。 |
| topicMetadataMaxAttempts | トピックメタデータの取得を試行する回数。 |
| integer | |
| tlsSidecar | TLS サイドカーの設定。 |
| logging |
ロギング設定。タイプは、指定のオブジェクト内の |
| jvmOptions | Pod の JVM オプション。 |
| livenessProbe | Pod の liveness チェック。 |
| readinessProbe | Pod の readiness チェック。 |
B.60. EntityOperatorJvmOptions スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
EntityTopicOperatorSpec、EntityUserOperatorSpec、TopicOperatorSpec で使用
| プロパティー | 説明 |
|---|---|
| gcLoggingEnabled | ガベージコレクションのロギングが有効かどうかを指定します。デフォルトは false です。 |
| boolean |
B.61. EntityOperatorSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaSpec で使用
| プロパティー | 説明 |
|---|---|
| topicOperator | Topic Operator の設定。 |
| userOperator | User Operator の設定。 |
| affinity |
|
| tolerations |
|
| Toleration array | |
| tlsSidecar | TLS サイドカーの設定。 |
| template |
Entity Operator リソースのテンプレート。テンプレートを使用すると、ユーザーは |
B.62. EntityTopicOperatorSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| watchedNamespace | Topic Operator が監視する必要のある namespace。 |
| string | |
| image | Topic Operator に使用するイメージ。 |
| string | |
| reconciliationIntervalSeconds | 定期的な調整の間隔。 |
| integer | |
| zookeeperSessionTimeoutSeconds | ZooKeeper セッションのタイムアウト。 |
| integer | |
| livenessProbe | Pod の liveness チェック。 |
| readinessProbe | Pod の readiness チェック。 |
| resources | 予約する CPU およびメモリーリソース。 |
| topicMetadataMaxAttempts | トピックメタデータの取得を試行する回数。 |
| integer | |
| logging |
ロギング設定。タイプは、指定のオブジェクト内の |
| jvmOptions | Pod の JVM オプション。 |
B.63. EntityUserOperatorSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| watchedNamespace | User Operator が監視する必要のある namespace。 |
| string | |
| image | User Operator に使用するイメージ。 |
| string | |
| reconciliationIntervalSeconds | 定期的な調整の間隔。 |
| integer | |
| zookeeperSessionTimeoutSeconds | ZooKeeper セッションのタイムアウト。 |
| integer | |
| livenessProbe | Pod の liveness チェック。 |
| readinessProbe | Pod の readiness チェック。 |
| resources | 予約する CPU およびメモリーリソース。 |
| logging |
ロギング設定。タイプは、指定のオブジェクト内の |
| jvmOptions | Pod の JVM オプション。 |
B.64. EntityOperatorTemplate スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| deployment |
Entity Operator |
| pod |
Entity Operator |
| tlsSidecarContainer | Entity Operator TLS サイドカーコンテナーのテンプレート。 |
| topicOperatorContainer | Entity Topic Operator コンテナーのテンプレート。 |
| userOperatorContainer | Entity User Operator コンテナーのテンプレート。 |
B.65. CertificateAuthority スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaSpec で使用
TLS 証明書のクラスター内での使用方法の設定。これは、クラスター内の内部通信に使用される証明書および Kafka.spec.kafka.listeners.tls を介したクライアントアクセスに使用される証明書の両方に適用されます。
| プロパティー | 説明 |
|---|---|
| generateCertificateAuthority | true の場合、認証局の証明書が自動的に生成されます。それ以外の場合は、ユーザーは CA 証明書で Secret を提供する必要があります。デフォルトは true です。 |
| boolean | |
| validityDays | 生成される証明書の有効日数。デフォルトは 365 です。 |
| integer | |
| renewalDays |
証明書更新期間の日数。これは、証明書の期限が切れるまでの日数です。この間に、更新アクションを実行することができます。 |
| integer | |
| certificateExpirationPolicy |
|
| string ([replace-key、renew-certificate] のいずれか) |
B.66. KafkaExporterSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaSpec で使用
| プロパティー | 説明 |
|---|---|
| image | Pod の Docker イメージ。 |
| string | |
| groupRegex |
収集するコンシューマーグループを指定する正規表現。デフォルト値は |
| string | |
| topicRegex |
収集するトピックを指定する正規表現。デフォルト値は |
| string | |
| resources | 予約する CPU およびメモリーリソース。 |
| logging |
指定の重大度以上のログメッセージのみ。有効な値: [ |
| string | |
| enableSaramaLogging | Kafka Exporter によって使用される Go クライアントライブラリーである Sarama ロギングを有効にします。 |
| boolean | |
| template | デプロイメントテンプレートおよび Pod のカスタマイズ。 |
| livenessProbe | Pod の liveness チェック。 |
| readinessProbe | Pod の readiness チェック。 |
B.67. KafkaExporterTemplate スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| deployment |
Kafka Exporter |
| pod |
Kafka Exporter |
| service |
Kafka Exporter |
| container | Kafka Exporter コンテナーのテンプレート。 |
B.68. KafkaStatus スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
Kafka で使用
| プロパティー | 説明 |
|---|---|
| conditions | ステータス条件の一覧。 |
|
| |
| observedGeneration | 最後に Operator によって調整された CRD の生成。 |
| integer | |
| listeners | 内部リスナーおよび外部リスナーのアドレス。 |
|
|
B.69. Condition スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridgeStatus、KafkaConnectorStatus、KafkaConnectS2IStatus、KafkaConnectStatus、KafkaMirrorMaker2Status、KafkaMirrorMakerStatus、KafkaStatus、KafkaTopicStatus、KafkaUserStatus で使用
| プロパティー | 説明 |
|---|---|
| type | リソース内の他の条件と区別するために使用される条件の固有識別子。 |
| string | |
| status | 条件のステータス (True、False、または Unknown のいずれか)。 |
| string | |
| lastTransitionTime | タイプの条件がある状態から別の状態へと最後に変更した時間。必須形式は、UTC タイムゾーンの 'yyyy-MM-ddTHH:mm:ssZ' です。 |
| string | |
| reason | 条件の最後の遷移の理由 (CamelCase の単一の単語)。 |
| string | |
| message | 条件の最後の遷移の詳細を示す、人間が判読できるメッセージ。 |
| string |
B.70. ListenerStatus スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaStatus で使用
| プロパティー | 説明 |
|---|---|
| type |
リスナーのタイプ。次の 3 つのタイプのいずれかになります: |
| string | |
| addresses | このリスナーのアドレス一覧。 |
|
| |
| certificates |
指定のリスナーへの接続時に、サーバーのアイデンティティーを検証するために使用できる TLS 証明書の一覧。 |
| string array |
B.71. ListenerAddress スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
ListenerStatus で使用
| プロパティー | 説明 |
|---|---|
| host | Kafka ブートストラップサービスの DNS 名または IP アドレス。 |
| string | |
| port | Kafka ブートストラップサービスのポート。 |
| integer |
B.72. KafkaConnect スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| spec | Kafka Connect クラスターの仕様。 |
| status | Kafka Connect クラスターのステータス。 |
B.73. KafkaConnectSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaConnect で使用
| プロパティー | 説明 |
|---|---|
| replicas | Kafka Connect グループの Pod 数。 |
| integer | |
| version | Kafka Connect のバージョン。デフォルトは 2.4.0 です。バージョンのアップグレードまたはダウングレードに必要なプロセスを理解するには、ユーザードキュメントを参照してください。 |
| string | |
| image | Pod の Docker イメージ。 |
| string | |
| bootstrapServers | 接続するブートストラップサーバー。これは <hostname>:<port> ペアのコンマ区切りリストとして指定する必要があります。 |
| string | |
| tls | TLS 設定。 |
| authentication |
Kafka Connect の認証設定。タイプは、指定のオブジェクト内の |
|
| |
| config | Kafka Connect の設定。次の接頭辞を持つプロパティーは設定できません: ssl.、sasl.、security.、listeners、plugin.path、rest.、bootstrap.servers、consumer.interceptor.classes、producer.interceptor.classes |
| map | |
| resources | CPU とメモリーリソースおよび要求された初期リソースの上限。 |
| livenessProbe | Pod の liveness チェック。 |
| readinessProbe | Pod の readiness チェック。 |
| jvmOptions | Pod の JVM オプション。 |
| affinity |
|
| tolerations |
|
| Toleration array | |
| logging |
Kafka Connect のロギング設定。タイプは、指定のオブジェクト内の |
| metrics | Prometheus JMX エクスポーターの設定。この設定の構造に関する詳細は、https://github.com/prometheus/jmx_exporter を参照してください。 |
| map | |
| tracing |
Kafka Connect でのトレーシングの設定。タイプは、指定のオブジェクト内の |
| template |
Kafka Connect および Kafka Connect S2I リソースのテンプレート。テンプレートを使用すると、ユーザーは |
| externalConfiguration | Secret または ConfigMap から Kafka Connect Pod にデータを渡し、これを使用してコネクターを設定します。 |
B.74. KafkaConnectTls スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaConnectS2ISpec、KafkaConnectSpec で使用
| プロパティー | 説明 |
|---|---|
| trustedCertificates | TLS 接続の信頼済み証明書。 |
|
|
B.75. KafkaClientAuthenticationTls スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridgeSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2ClusterSpec、KafkaMirrorMakerConsumerSpec、KafkaMirrorMakerProducerSpec で使用
TLS クライアント認証を使用するには、type プロパティーを tls の値に設定します。TLS クライアント認証は TLS 証明書を使用して認証します。証明書は certificateAndKey プロパティーで指定され、常に OpenShift シークレットからロードされます。シークレットでは、公開鍵と秘密鍵の 2 つの鍵を使用して証明書を X509 形式で保存する必要があります。
TLS クライアント認証は TLS 接続でのみ使用できます。
TLS クライアント認証の設定例
authentication:
type: tls
certificateAndKey:
secretName: my-secret
certificate: public.crt
key: private.key
type プロパティーは、KafkaClientAuthenticationTls タイプを使用する際に KafkaClientAuthenticationScramSha512、KafkaClientAuthenticationPlain、および KafkaClientAuthenticationOAuth タイプと区別する識別子です。KafkaClientAuthenticationTls タイプには tls の値が必要です。
| プロパティー | 説明 |
|---|---|
| certificateAndKey |
証明書と秘密鍵のペアを保持する |
| type |
|
| string |
B.76. KafkaClientAuthenticationScramSha512 スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridgeSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2ClusterSpec、KafkaMirrorMakerConsumerSpec、KafkaMirrorMakerProducerSpec で使用
SASL ベースの SCRAM-SHA-512 認証を設定するには、type プロパティーを scram-sha-512 に設定します。SCRAM-SHA-512 認証メカニズムには、ユーザー名とパスワードが必要です。
-
usernameプロパティーでユーザー名を指定します。 -
passwordSecretプロパティーで、パスワードを含むSecretへのリンクを指定します。secretNameプロパティーにはSecretの名前が含まれ、passwordプロパティーにはSecret内にパスワードが格納されるキーの名前が含まれます。
password フィールドには、実際のパスワードを指定しないでください。
SASL ベースの SCRAM-SHA-512 クライアント認証の設定例
authentication:
type: scram-sha-512
username: my-connect
passwordSecret:
secretName: my-connect
password: password
type プロパティーは、KafkaClientAuthenticationScramSha512 タイプを使用する際に KafkaClientAuthenticationTls、KafkaClientAuthenticationPlain、および KafkaClientAuthenticationOAuth タイプと区別する識別子です。KafkaClientAuthenticationScramSha512 タイプには scram-sha-512 の値が必要です。
| プロパティー | 説明 |
|---|---|
| passwordSecret |
パスワードを保持する |
| type |
|
| string | |
| username | 認証に使用されるユーザー名。 |
| string |
B.77. PasswordSecretSource スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaClientAuthenticationPlain、KafkaClientAuthenticationScramSha512 で使用
| プロパティー | 説明 |
|---|---|
| password | パスワードが保存される Secret のキーの名前。 |
| string | |
| secretName | パスワードを含むシークレットの名前。 |
| string |
B.78. KafkaClientAuthenticationPlain スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridgeSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2ClusterSpec、KafkaMirrorMakerConsumerSpec、KafkaMirrorMakerProducerSpec で使用
SASL ベースの PLAIN 認証を設定するには、type プロパティーを plain に設定します。SASL PLAIN 認証メカニズムには、ユーザー名とパスワードが必要です。
SASL PLAIN メカニズムは、クリアテキストでユーザー名とパスワードをネットワーク全体に転送します。TLS 暗号化が有効になっている場合にのみ SASL PLAIN 認証を使用します。
-
usernameプロパティーでユーザー名を指定します。 -
passwordSecretプロパティーで、パスワードを含むSecretへのリンクを指定します。secretNameプロパティーにはそのようなSecretの名前が含まれ、passwordプロパティーにはSecret内にパスワードが格納されるキーの名前が含まれます。
password フィールドには、実際のパスワードを指定しないでください。
SASL ベースの PLAIN クライアント認証の設定例
authentication:
type: plain
username: my-connect
passwordSecret:
secretName: my-connect
password: password
type プロパティーは、KafkaClientAuthenticationPlain タイプを使用する際に KafkaClientAuthenticationTls、KafkaClientAuthenticationScramSha512、および KafkaClientAuthenticationOAuth タイプと区別する識別子です。KafkaClientAuthenticationPlain タイプには plain の値が必要です。
| プロパティー | 説明 |
|---|---|
| passwordSecret |
パスワードを保持する |
| type |
|
| string | |
| username | 認証に使用されるユーザー名。 |
| string |
B.79. KafkaClientAuthenticationOAuth スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridgeSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2ClusterSpec、KafkaMirrorMakerConsumerSpec、KafkaMirrorMakerProducerSpec で使用
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
type プロパティーは、KafkaClientAuthenticationOAuth タイプを使用する際に KafkaClientAuthenticationTls、KafkaClientAuthenticationScramSha512、および KafkaClientAuthenticationPlain タイプと区別する識別子です。KafkaClientAuthenticationOAuth タイプには oauth の値が必要です。
| プロパティー | 説明 |
|---|---|
| accessToken | 承認サーバーから取得したアクセストークンが含まれる OpenShift シークレットへのリンク。 |
| accessTokenIsJwt |
アクセストークンを JWT として処理すべきかどうかを設定します。承認サーバーが不透明なトークンを返す場合は |
| boolean | |
| clientId | Kafka クライアントが OAuth サーバーに対する認証に使用し、トークンエンドポイント URI を使用することができる OAuth クライアント ID。 |
| string | |
| clientSecret | Kafka クライアントが OAuth サーバーに対する認証に使用し、トークンエンドポイント URI を使用することができる OAuth クライアントシークレットが含まれる OpenShift シークレットへのリンク。 |
| disableTlsHostnameVerification |
TLS ホスト名の検証を有効または無効にします。デフォルト値は |
| boolean | |
| maxTokenExpirySeconds | アクセストークンの有効期間を指定の秒数に設定または制限します。これは、承認サーバーが不透明なトークンを返す場合に設定する必要があります。 |
| integer | |
| refreshToken | 承認サーバーからアクセストークンを取得するために使用できる更新トークンが含まれる OpenShift シークレットへのリンク。 |
| tlsTrustedCertificates | OAuth サーバーへの TLS 接続の信頼済み証明書。 |
|
| |
| tokenEndpointUri | 承認サーバートークンエンドポイント URI。 |
| string | |
| type |
|
| string |
B.80. JaegerTracing スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridgeSpec、KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2Spec、KafkaMirrorMakerSpec で使用
type プロパティーは、JaegerTracing タイプを使用する際に、今後追加される可能性のある他のサブタイプと区別する識別子です。JaegerTracing タイプには jaeger の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string |
B.81. KafkaConnectTemplate スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2Spec で使用
| プロパティー | 説明 |
|---|---|
| deployment |
Kafka Connect |
| pod |
Kafka Connect |
| apiService |
Kafka Connect API |
| connectContainer | Kafka Connect コンテナーのテンプレート。 |
| podDisruptionBudget |
Kafka Connect |
B.82. ExternalConfiguration スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaConnectS2ISpec、KafkaConnectSpec、KafkaMirrorMaker2Spec で使用
| プロパティー | 説明 |
|---|---|
| env | Secret または ConfigMap からのデータを環境変数として Kafka Connect Pod に渡すことを許可します。 |
|
| |
| volumes | Secret または ConfigMap からのデータをボリュームとして Kafka Connect Pod に渡すことを許可します。 |
B.83. ExternalConfigurationEnv スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| name |
Kafka Connect Pod に渡される環境変数の名前。環境変数に、 |
| string | |
| valueFrom | Kafka Connect Pod に渡される環境変数の値。Secret または ConfigMap フィールドのいずれかへ参照として渡すことができます。このフィールドでは、Secret または ConfigMap を 1 つだけ指定する必要があります。 |
B.84. ExternalConfigurationEnvVarSource スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| configMapKeyRef | ConfigMap のキーへの参照。外部のドキュメント core/v1 configmapkeyselector を参照してください。 |
| secretKeyRef | Secret のキーへの参照。外部のドキュメント core/v1 secretkeyselector を参照してください。 |
B.85. ExternalConfigurationVolumeSource スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| configMap | ConfigMap のキーへの参照。Secret または ConfigMap を 1 つだけ指定する必要があります。外部のドキュメント core/v1 configmapvolumesource を参照してください。 |
| name | Kafka Connect Pod に追加されるボリュームの名前。 |
| string | |
| secret | Secret のキーへの参照。Secret または ConfigMap を 1 つだけ指定する必要があります。外部のキュメント core/v1 secretvolumesource を参照してください。 |
B.86. KafkaConnectStatus スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaConnect で使用
| プロパティー | 説明 |
|---|---|
| conditions | ステータス条件の一覧。 |
|
| |
| observedGeneration | 最後に Operator によって調整された CRD の生成。 |
| integer | |
| url | Kafka Connect コネクターの管理および監視用の REST API エンドポイントの URL。 |
| string | |
| connectorPlugins | この Kafka Connect デプロイメントで使用できるコネクタープラグインの一覧。 |
|
|
B.87. ConnectorPlugin スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaConnectS2IStatus、KafkaConnectStatus、KafkaMirrorMaker2Status で使用
| プロパティー | 説明 |
|---|---|
| type |
コネクタープラグインのタイプ。利用可能なタイプは、 |
| string | |
| version | コネクタープラグインのバージョン。 |
| string | |
| class | コネクタープラグインのクラス。 |
| string |
B.88. KafkaConnectS2I スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| spec | Kafka Connect Source-to-Image (S2I) クラスターの仕様。 |
| status | Kafka Connect Source-to-Image (S2I) クラスターのステータス。 |
B.89. KafkaConnectS2ISpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaConnectS2I で使用
| プロパティー | 説明 |
|---|---|
| replicas | Kafka Connect グループの Pod 数。 |
| integer | |
| image | Pod の Docker イメージ。 |
| string | |
| buildResources | 予約する CPU およびメモリーリソース。 |
| livenessProbe | Pod の liveness チェック。 |
| readinessProbe | Pod の readiness チェック。 |
| jvmOptions | Pod の JVM オプション。 |
| affinity |
|
| logging |
Kafka Connect のロギング設定。タイプは、指定のオブジェクト内の |
| metrics | Prometheus JMX エクスポーターの設定。この設定の構造に関する詳細は、https://github.com/prometheus/jmx_exporter を参照してください。 |
| map | |
| template |
Kafka Connect および Kafka Connect S2I リソースのテンプレート。テンプレートを使用すると、ユーザーは |
| authentication |
Kafka Connect の認証設定。タイプは、指定のオブジェクト内の |
|
| |
| bootstrapServers | 接続するブートストラップサーバー。これは <hostname>:<port> ペアのコンマ区切りリストとして指定する必要があります。 |
| string | |
| config | Kafka Connect の設定。次の接頭辞を持つプロパティーは設定できません: ssl.、sasl.、security.、listeners、plugin.path、rest.、bootstrap.servers、consumer.interceptor.classes、producer.interceptor.classes |
| map | |
| externalConfiguration | Secret または ConfigMap から Kafka Connect Pod にデータを渡し、これを使用してコネクターを設定します。 |
| insecureSourceRepository | true の場合、'Local' 参照ポリシーとセキュアでないソースタグを受け入れるインポートポリシーを使用してソースリポジトリーを設定します。 |
| boolean | |
| resources | CPU とメモリーリソースおよび要求された初期リソースの上限。 |
| tls | TLS 設定。 |
| tolerations |
|
| Toleration array | |
| tracing |
Kafka Connect でのトレーシングの設定。タイプは、指定のオブジェクト内の |
| version | Kafka Connect のバージョン。デフォルトは 2.4.0 です。バージョンのアップグレードまたはダウングレードに必要なプロセスを理解するには、ユーザードキュメントを参照してください。 |
| string |
B.90. KafkaConnectS2IStatus スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaConnectS2I で使用
| プロパティー | 説明 |
|---|---|
| conditions | ステータス条件の一覧。 |
|
| |
| observedGeneration | 最後に Operator によって調整された CRD の生成。 |
| integer | |
| url | Kafka Connect コネクターの管理および監視用の REST API エンドポイントの URL。 |
| string | |
| connectorPlugins | この Kafka Connect デプロイメントで使用できるコネクタープラグインの一覧。 |
|
| |
| buildConfigName | ビルド設定の名前。 |
| string |
B.91. KafkaTopic スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| spec | トピックの仕様。 |
| status | トピックのステータス。 |
B.92. KafkaTopicSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaTopic で使用
| プロパティー | 説明 |
|---|---|
| partitions | トピックに存在するパーティション数。この数はトピック作成後に減らすことはできません。トピック作成後に増やすことはできますが、その影響について理解することが重要となります。特にセマンティックパーティションのあるトピックで重要となります。 |
| integer | |
| replicas | トピックのレプリカ数。 |
| integer | |
| config | トピックの設定。 |
| map | |
| topicName | トピックの名前。これがない場合、デフォルトではトピックの metadata.name に設定されます。トピック名が有効な OpenShift リソース名ではない場合を除き、これを設定しないことが推奨されます。 |
| string |
B.93. KafkaTopicStatus スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaTopic で使用
| プロパティー | 説明 |
|---|---|
| conditions | ステータス条件の一覧。 |
|
| |
| observedGeneration | 最後に Operator によって調整された CRD の生成。 |
| integer |
B.94. KafkaUser スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| spec | ユーザーの仕様。 |
| status | Kafka User のステータス。 |
B.95. KafkaUserSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaUser で使用
| プロパティー | 説明 |
|---|---|
| authentication |
この Kafka ユーザーに対して有効になっている認証メカニズム。タイプは、指定のオブジェクト内の |
|
| |
| authorization |
この Kafka ユーザーの承認ルール。タイプは、指定のオブジェクト内の |
| quotas | クライアントによって使用されるブローカーリソースを制御する要求のクォータ。ネットワーク帯域幅および要求レートクォータの適用が可能です。Kafka ユーザークォータの Kafka ドキュメントは http://kafka.apache.org/documentation/#design_quotas を参照してください。 |
B.96. KafkaUserTlsClientAuthentication スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaUserSpec で使用
type プロパティーは、KafkaUserTlsClientAuthentication タイプを使用する際に KafkaUserScramSha512ClientAuthentication タイプと区別する識別子です。KafkaUserTlsClientAuthentication タイプには tls の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string |
B.97. KafkaUserScramSha512ClientAuthentication スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaUserSpec で使用
type プロパティーは、KafkaUserScramSha512ClientAuthentication タイプを使用する際に KafkaUserTlsClientAuthentication タイプと区別する識別子です。KafkaUserScramSha512ClientAuthentication タイプには scram-sha-512 の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string |
B.98. KafkaUserAuthorizationSimple スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaUserSpec で使用
type プロパティーは、KafkaUserAuthorizationSimple タイプを使用する際に、今後追加される可能性のある他のサブタイプと区別する識別子です。KafkaUserAuthorizationSimple タイプには simple の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string | |
| ACL | このユーザーに適用される必要のある ACL ルールの一覧。 |
|
|
B.99. AclRule スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaUserAuthorizationSimple で使用
| プロパティー | 説明 |
|---|---|
| host | ACL ルールに記述されているアクションを許可または拒否するホスト。 |
| string | |
| 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 ルールが適用されるリソースを示します。タイプは、指定のオブジェクト内の |
|
| |
| type |
ルールのタイプ。現在サポートされているタイプは |
| string ([allow、deny] のいずれか) |
B.100. AclRuleTopicResource スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
AclRule で使用
type プロパティーは、AclRuleTopicResource タイプを使用する際に AclRuleGroupResource、AclRuleClusterResource、および AclRuleTransactionalIdResource タイプと区別する識別子です。AclRuleTopicResource タイプには topic の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string | |
| name |
指定の ACL ルールが適用されるリソースの名前。 |
| string | |
| patternType |
リソースフィールドで使用されるパターンを指定します。サポートされるタイプは |
| string ([prefix、literal] のいずれか) |
B.101. AclRuleGroupResource スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
AclRule で使用
type プロパティーは、AclRuleGroupResource タイプを使用する際に AclRuleTopicResource、AclRuleClusterResource、および AclRuleTransactionalIdResource タイプと区別する識別子です。AclRuleGroupResource タイプには group の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string | |
| name |
指定の ACL ルールが適用されるリソースの名前。 |
| string | |
| patternType |
リソースフィールドで使用されるパターンを指定します。サポートされるタイプは |
| string ([prefix、literal] のいずれか) |
B.102. AclRuleClusterResource スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
AclRule で使用
type プロパティーは、AclRuleClusterResource タイプを使用する際に AclRuleTopicResource、AclRuleGroupResource、および AclRuleTransactionalIdResource タイプと区別する識別子です。AclRuleClusterResource タイプには cluster の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string |
B.103. AclRuleTransactionalIdResource スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
AclRule で使用
type プロパティーは、AclRuleTransactionalIdResource タイプを使用する際に AclRuleTopicResource、AclRuleGroupResource、および AclRuleClusterResource タイプと区別する識別子です。AclRuleTransactionalIdResource タイプには transactionalId の値が必要です。
| プロパティー | 説明 |
|---|---|
| type |
|
| string | |
| name |
指定の ACL ルールが適用されるリソースの名前。 |
| string | |
| patternType |
リソースフィールドで使用されるパターンを指定します。サポートされるタイプは |
| string ([prefix、literal] のいずれか) |
B.104. KafkaUserQuotas スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaUserSpec で使用
Kafka では、ユーザーは特定のクォータを適用して、クライアントによるリソースの使用を制御することができます。クォータは、2 つのカテゴリーに分類されます。
- ネットワーク使用率 クォータ。これは、クォータを共有するクライアントの各グループのバイトレートしきい値として定義されます。
- CPU 使用率 クォータ。これは、クライアントがクォータウィンドウ内の各ブローカーのリクエストハンドラー I/O スレッドおよびネットワークスレッドで使用可能な時間の割合として定義されます。
Kafka クライアントにクォータを使用することは、さまざまな状況で役に立つ場合があります。レートが高すぎる要求を送信する Kafka プロデューサーを誤って設定したとします。このように設定が間違っていると、他のクライアントにサービス拒否を引き起こす可能性があるため、問題のあるクライアントはブロックする必要があります。ネットワーク制限クォータを使用すると、他のクライアントがこの状況の著しい影響を受けないようにすることが可能です。
Strimzi はユーザーレベルのクォータをサポートしますが、クライアントレベルのクォータはサポートしません。
Kafka ユーザークォータの例
spec:
quotas:
producerByteRate: 1048576
consumerByteRate: 2097152
requestPercentage: 55
Kafka ユーザークォータの詳細は Apache Kafka ドキュメント を参照してください。
| プロパティー | 説明 |
|---|---|
| consumerByteRate | グループのクライアントにスロットリングが適用される前に、各クライアントグループがブローカーから取得できる最大 bps (ビット毎秒) のクオータ。ブローカーごとに定義されます。 |
| integer | |
| producerByteRate | グループのクライアントにスロットリングが適用される前に、各クライアントグループがブローカーにパブリッシュできる最大 bps (ビット毎秒) のクオータ。ブローカーごとに定義されます。 |
| integer | |
| requestPercentage | 各クライアントグループの最大 CPU 使用率のクォータ。ネットワークと I/O スレッドの比率 (パーセント) として指定。 |
| integer |
B.105. KafkaUserStatus スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaUser で使用
| プロパティー | 説明 |
|---|---|
| conditions | ステータス条件の一覧。 |
|
| |
| observedGeneration | 最後に Operator によって調整された CRD の生成。 |
| integer | |
| username | ユーザー名。 |
| string | |
| secret |
認証情報が保存される |
| string |
B.106. KafkaMirrorMaker スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| spec | Kafka MirrorMaker の仕様。 |
| status | Kafka MirrorMaker のステータス。 |
B.107. KafkaMirrorMakerSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaMirrorMaker で使用
| プロパティー | 説明 |
|---|---|
| replicas |
|
| integer | |
| image | Pod の Docker イメージ。 |
| string | |
| whitelist |
ミラーリングに含まれるトピックの一覧。このオプションは、Java スタイルの正規表現を使用するあらゆる正規表現を許可します。 |
| string | |
| consumer | ソースクラスターの設定。 |
| producer | ターゲットクラスターの設定。 |
| resources | 予約する CPU およびメモリーリソース。 |
| affinity |
|
| tolerations |
|
| Toleration array | |
| jvmOptions | Pod の JVM オプション。 |
| logging |
MirrorMaker のロギング設定。タイプは、指定のオブジェクト内の |
| metrics | Prometheus JMX エクスポーターの設定。この設定の構造に関する詳細は、JMX Exporter のドキュメント を参照してください。 |
| map | |
| tracing |
Kafka MirrorMaker でのトレーシングの設定。タイプは、指定のオブジェクト内の |
| template |
Kafka MirrorMaker のリソースである |
| livenessProbe | Pod の liveness チェック。 |
| readinessProbe | Pod の readiness チェック。 |
| version | Kafka MirrorMaker のバージョン。デフォルトは 2.4.0 です。バージョンのアップグレードまたはダウングレードに必要なプロセスを理解するには、ドキュメントを参照してください。 |
| string |
B.108. KafkaMirrorMakerConsumerSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| numStreams | 作成するコンシューマーストリームスレッドの数を指定します。 |
| integer | |
| offsetCommitInterval | オフセットの自動コミット間隔をミリ秒単位で指定します。デフォルト値は 60000 です。 |
| integer | |
| groupId | このコンシューマーが属するコンシューマーグループを識別する一意の文字列。 |
| string | |
| bootstrapServers | Kafka クラスターへの最初の接続を確立するための host:port ペアの一覧。 |
| string | |
| authentication |
クラスターに接続するための認証設定。タイプは、指定のオブジェクト内の |
|
| |
| config | MirrorMaker のコンシューマー設定。次の接頭辞を持つプロパティーは設定できません: ssl.、bootstrap.servers、group.id、sasl.、security.、interceptor.classes |
| map | |
| tls | MirrorMaker をクラスターに接続するための TLS 設定。 |
B.109. KafkaMirrorMakerTls スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaMirrorMakerConsumerSpec、KafkaMirrorMakerProducerSpec で使用
tls プロパティーを使用して、TLS 暗号化を設定します。証明書が X.509 形式で保存されるキーの名前でシークレットの一覧を提供します。
TLS 暗号化の設定例
tls:
trustedCertificates:
- secretName: my-cluster-cluster-ca-cert
certificate: ca.crt
| プロパティー | 説明 |
|---|---|
| trustedCertificates | TLS 接続の信頼済み証明書。 |
|
|
B.110. KafkaMirrorMakerProducerSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| bootstrapServers | Kafka クラスターへの最初の接続を確立するための host:port ペアの一覧。 |
| string | |
| abortOnSendFailure |
送信失敗時に MirrorMaker が終了するように設定するフラグ。デフォルト値は |
| boolean | |
| authentication |
クラスターに接続するための認証設定。タイプは、指定のオブジェクト内の |
|
| |
| config | MirrorMaker プロデューサーの設定。次の接頭辞を持つプロパティーは設定できません: ssl.、bootstrap.servers、sasl.、security.、interceptor.classes |
| map | |
| tls | MirrorMaker をクラスターに接続するための TLS 設定。 |
B.111. KafkaMirrorMakerTemplate スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| deployment |
Kafka MirrorMaker |
| pod |
Kafka MirrorMaker |
| mirrorMakerContainer | Kafka MirrorMaker コンテナーのテンプレート。 |
| podDisruptionBudget |
Kafka MirrorMaker |
B.112. KafkaMirrorMakerStatus スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaMirrorMaker で使用
| プロパティー | 説明 |
|---|---|
| conditions | ステータス条件の一覧。 |
|
| |
| observedGeneration | 最後に Operator によって調整された CRD の生成。 |
| integer |
B.113. KafkaBridge スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| spec | Kafka Bridge の仕様。 |
| status | Kafka Bridge のステータス。 |
B.114. KafkaBridgeSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridge で使用
| プロパティー | 説明 |
|---|---|
| replicas |
|
| integer | |
| image | Pod の Docker イメージ。 |
| string | |
| bootstrapServers | Kafka クラスターへの最初の接続を確立するための host:port ペアの一覧。 |
| string | |
| tls | Kafka Bridge をクラスターに接続するための TLS 設定。 |
| authentication |
クラスターに接続するための認証設定。タイプは、指定のオブジェクト内の |
|
| |
| http | HTTP 関連の設定。 |
| consumer | Kafka コンシューマーに関連する設定。 |
| producer | Kafka プロデューサーに関連する設定。 |
| resources | 予約する CPU およびメモリーリソース。 |
| jvmOptions | 現時点でサポートされていない Pod の JVM オプション。 |
| logging |
Kafka Bridge のロギング設定。タイプは、指定のオブジェクト内の |
| metrics | 現時点でサポートされていない Prometheus JMX Exporter 設定。この設定の構造に関する詳細は、JMX Exporter のドキュメント を参照してください。 |
| map | |
| livenessProbe | Pod の liveness チェック。 |
| readinessProbe | Pod の readiness チェック。 |
| template |
Kafka Bridge リソースのテンプレート。テンプレートを使用すると、ユーザーは |
| tracing |
Kafka Bridge でのトレーシングの設定。タイプは、指定のオブジェクト内の |
B.115. KafkaBridgeTls スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridgeSpec で使用
| プロパティー | 説明 |
|---|---|
| trustedCertificates | TLS 接続の信頼済み証明書。 |
|
|
B.116. KafkaBridgeHttpConfig スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridgeSpec で使用
| プロパティー | 説明 |
|---|---|
| port | サーバーがリッスンするポート。 |
| integer |
B.117. KafkaBridgeConsumerSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridgeSpec で使用
| プロパティー | 説明 |
|---|---|
| config | ブリッジによって作成されたコンシューマーインスタンスに使用される Kafka コンシューマーの設定。次の接頭辞を持つプロパティーは設定できません: ssl.、bootstrap.servers、group.id、sasl.、security |
| map |
B.118. KafkaBridgeProducerSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridgeSpec で使用
| プロパティー | 説明 |
|---|---|
| config | ブリッジによって作成されたプロデューサーインスタンスに使用される Kafka プロデューサーの設定。次の接頭辞を持つプロパティーは設定できません: ssl.、bootstrap.servers、sasl.、security |
| map |
B.119. KafkaBridgeTemplate スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridgeSpec で使用
| プロパティー | 説明 |
|---|---|
| deployment |
Kafka Bridge |
| pod |
Kafka Bridge |
| apiService |
Kafka Bridge API |
| bridgeContainer | Kafka Bridge コンテナーのテンプレート。 |
| podDisruptionBudget |
Kafka Bridge |
B.120. KafkaBridgeStatus スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaBridge で使用
| プロパティー | 説明 |
|---|---|
| conditions | ステータス条件の一覧。 |
|
| |
| observedGeneration | 最後に Operator によって調整された CRD の生成。 |
| integer | |
| url | 外部クライアントアプリケーションが Kafka Bridge にアクセスできる URL。 |
| string |
B.121. KafkaConnector スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| spec | Kafka Connector の仕様。 |
| status | Kafka Connector のステータス。 |
B.122. KafkaConnectorSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaConnector で使用
| プロパティー | 説明 |
|---|---|
| class | Kafka Connector のクラス。 |
| string | |
| tasksMax | Kafka Connector のタスクの最大数。 |
| integer | |
| config | Kafka Connector の設定。次のプロパティーは設定できません: connector.class、tasks.max |
| map | |
| pause | コネクターを一時停止すべきかどうか。デフォルトは false です。 |
| boolean |
B.123. KafkaConnectorStatus スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaConnector で使用
| プロパティー | 説明 |
|---|---|
| conditions | ステータス条件の一覧。 |
|
| |
| observedGeneration | 最後に Operator によって調整された CRD の生成。 |
| integer | |
| connectorStatus | Kafka Connect REST API によって報告されるコネクターのステータス。 |
| map |
B.124. KafkaMirrorMaker2 スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| spec | Kafka MirrorMaker 2.0 クラスターの仕様。 |
| status | Kafka MirrorMaker 2.0 クラスターのステータス。 |
B.125. KafkaMirrorMaker2Spec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| replicas | Kafka Connect グループの Pod 数。 |
| integer | |
| version | Kafka Connect のバージョン。デフォルトは 2.4.0 です。バージョンのアップグレードまたはダウングレードに必要なプロセスを理解するには、ユーザードキュメントを参照してください。 |
| string | |
| image | Pod の Docker イメージ。 |
| string | |
| connectCluster |
Kafka Connect に使用されるクラスターエイリアス。エイリアスは |
| string | |
| clusters | ミラーリング用の Kafka クラスター。 |
| mirrors | MirrorMaker 2.0 コネクターの設定。 |
| resources | CPU とメモリーリソースおよび要求された初期リソースの上限。 |
| livenessProbe | Pod の liveness チェック。 |
| readinessProbe | Pod の readiness チェック。 |
| jvmOptions | Pod の JVM オプション。 |
| affinity |
|
| tolerations |
|
| Toleration array | |
| logging |
Kafka Connect のロギング設定。タイプは、指定のオブジェクト内の |
| metrics | Prometheus JMX エクスポーターの設定。この設定の構造に関する詳細は、https://github.com/prometheus/jmx_exporter を参照してください。 |
| map | |
| tracing |
Kafka Connect でのトレーシングの設定。タイプは、指定のオブジェクト内の |
| template |
Kafka Connect および Kafka Connect S2I リソースのテンプレート。テンプレートを使用すると、ユーザーは |
| externalConfiguration | Secret または ConfigMap から Kafka Connect Pod にデータを渡し、これを使用してコネクターを設定します。 |
B.126. KafkaMirrorMaker2ClusterSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| alias | Kafka クラスターの参照に使用されるエイリアス。 |
| string | |
| bootstrapServers |
Kafka クラスターへの接続を確立するための |
| string | |
| config | MirrorMaker 2.0 クラスターの設定。次の接頭辞を持つプロパティーは設定できません: ssl.、sasl.、security.、listeners、plugin.path、rest.、bootstrap.servers、consumer.interceptor.classes、producer.interceptor.classes (ssl.endpoint.identification.algorithm を除く) |
| map | |
| tls | MirrorMaker 2.0 コネクターをクラスターに接続するための TLS 設定。 |
| authentication |
クラスターに接続するための認証設定。タイプは、指定のオブジェクト内の |
|
|
B.127. KafkaMirrorMaker2Tls スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaMirrorMaker2ClusterSpec で使用
| プロパティー | 説明 |
|---|---|
| trustedCertificates | TLS 接続の信頼済み証明書。 |
|
|
B.128. KafkaMirrorMaker2MirrorSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| sourceCluster |
Kafka MirrorMaker 2.0 コネクターによって使用されるソースクラスターのエイリアス。エイリアスは |
| string | |
| targetCluster |
Kafka MirrorMaker 2.0 コネクターによって使用されるターゲットクラスターのエイリアス。エイリアスは |
| string | |
| sourceConnector | Kafka MirrorMaker 2.0 ソースコネクターの仕様。 |
| checkpointConnector | Kafka MirrorMaker 2.0 チェックポイントコネクターの仕様。 |
| heartbeatConnector | Kafka MirrorMaker 2.0 ハートビートコネクターの仕様。 |
| topicsPattern | ミラーリングするトピックに一致する正規表現 (例: "topic1|topic2|topic3")。コンマ区切りリストもサポートされます。 |
| string | |
| topicsBlacklistPattern | ミラーリングから除外するトピックに一致する正規表現。コンマ区切りリストもサポートされます。 |
| string | |
| groupsPattern | ミラーリングされるコンシューマーグループに一致する正規表現。コンマ区切りリストもサポートされます。 |
| string | |
| groupsBlacklistPattern | ミラーリングから除外するコンシューマーグループに一致する正規表現。コンマ区切りリストもサポートされます。 |
| string |
B.129. KafkaMirrorMaker2ConnectorSpec スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
KafkaMirrorMaker2MirrorSpec で使用
| プロパティー | 説明 |
|---|---|
| tasksMax | Kafka Connector のタスクの最大数。 |
| integer | |
| config | Kafka Connector の設定。次のプロパティーは設定できません: connector.class、tasks.max |
| map | |
| pause | コネクターを一時停止すべきかどうか。デフォルトは false です。 |
| boolean |
B.130. KafkaMirrorMaker2Status スキーマ参照 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 説明 |
|---|---|
| conditions | ステータス条件の一覧。 |
|
| |
| observedGeneration | 最後に Operator によって調整された CRD の生成。 |
| integer | |
| url | Kafka Connect コネクターの管理および監視用の REST API エンドポイントの URL。 |
| string | |
| connectorPlugins | この Kafka Connect デプロイメントで使用できるコネクタープラグインの一覧。 |
|
| |
| connectors | Kafka Connect REST API によって報告される MirrorMaker 2.0 コネクターステータスの一覧。 |
| map array |