Control Center 構成リファレンス

Control Center の構成に使用できる設定は以下のとおりです。

重要

プロパティファイル内の文字列を二重引用符で囲まないでください。ただし、ヘッダー値には二重引用符を使用できます。

基本設定

Control Center は、起動時に Control Center に渡される構成 プロパティファイル で構成できます。Confluent Control Center では、複数のサンプル構成(.properties)ファイルが $CONFLUENT_HOME/etc/confluent-control-center ディレクトリに用意されています。サンプル構成ファイルのリストについては、「Control Center のプロパティファイル」を参照してください。

bootstrap.servers

Apache Kafka® クラスターへの初期接続の確立に使用するための、ホストとポートのペアのリスト。ここでブートストラップ用にどのサーバーが指定されているかにかかわらず、クライアントはすべてのサーバーを使用します。このリストは、すべてのサーバーを検出するために使用する最初のホストにのみ影響します。このリストは、host1:port1,host2:port2,... という形式にする必要があります。これらのサーバーは、初期接続ですべてのクラスターメンバーシップを検出するためにのみ使用されます。これは動的に変わる可能性があるので、このリストにすべてのサーバーセットを含める必要はありません(ただし、サーバーの障害に備えて、複数指定しておくこともできます)。

  • 型: list
  • デフォルト : localhost:9092
  • 重要度: 高
confluent.license

Confluent では、各契約者に対してエンタープライズライセンスキーを発行します。これにより、契約者は Control Center のすべての機能をロック解除できます。ライセンスキーは、コピーアンドペーストできるテキストです。confluent.license の値としてライセンスキーを貼り付けます。Control Center ウェブインターフェイスからライセンスを管理することもできます。

試用ライセンスでは、30 日間使用できます。開発者ライセンスでは、ブローカーが 1 つの開発環境で、Control Center およびその他の Confluent Platform プロプラエタリコンポーネントを無期限に使用できます。試用ライセンスおよび開発者ライセンスは Confluent Platform に付属しています。

詳細については、「Confluent Platform ライセンスの管理」を参照してください。

既にご契約されている場合は、期限切れになる前に別の有効なエンタープライズライセンスを入手する方法について Confluent サポートにお問い合わせください。confluent.controlcenter.license は、この構成キーと同じ意味を持ちますが、非推奨です。

  • 型: string
  • デフォルト: ""
  • 重要度: 高
confluent.controlcenter.rest.csrf.prevention.enable

有効になっている場合は、トークンベースのシステムを使用して、クロスサイトリクエストフォージェリ(CSRF)を防止します。CSRF は、エンドユーザーが現在認証されているウェブアプリケーションで望ましくないアクションを実行する可能性のある、悪意のあるエクスプロイトです。ターゲットユーザーが管理者アカウントを持っている場合、CSRF はウェブアプリケーション全体を侵害する可能性があります。

  • 型: ブール値
  • デフォルト: false
  • 重要度: 中
confluent.controlcenter.rest.csrf.prevention.token.expiration.minutes

CSRF 防止が有効になっている場合、CSRF 防止トークンの有効期限を設定します。ほとんどのユースケースでは、デフォルトの有効期限で十分ですが、この設定を使用すると、必要に応じてトークンの有効期限の長さを増減することもできます。

  • 型: int
  • デフォルト: 30
  • 重要度: 低

本稼働環境の設定

本稼働環境では、モニタリング対象の Kafka クラスターとは別のクラスター内で Control Center を実行する必要があります。モニタリング対象の Kafka クラスター内で以下の構成パラメーターを設定します。

confluent.controlcenter.streams.cache.max.bytes.buffering

すべてのスレッドでレコードキャッシュに使用されるメモリーの最大バイト数です。

ちなみに

この構成値は合計 num.partitions に比例した値に設定することを検討してください。この計算の一例を以下に示します。

  • パーティションごとの各メトリックは、"topic-string, partition-id, cluster-name" で構成されるキーと値のペアとして保管されます。Control Center では、この値を 4 つの長整数型変数に圧縮し、最小、最大、カウント、および合計を記録します。
  • X はトピックパーティションの合計、7 は Control Center が収集するパーティションごとのメトリクスの数です。
  • 8 はデフォルトでのスレッド数です。

合計キャッシュサイズは次のようになります。

X (topic partitions) * 7 (per-partition metrics) * 8 (number of threads) * 150 (average bytes per metric).

たとえば、トピックのパーティションが 100000 個ある場合、キャッシュサイズは 820000000 バイトになります。

  • 型:
  • デフォルト: 10485760 バイト
  • 重要度: 高
confluent.controlcenter.kafka.<name>.bootstrap.servers

モニタリング対象の追加の Kafka クラスターに対するブートストラップサーバーです。<name> は、このクラスターを識別するために Control Center で使用する名前で置き換えます。たとえば、confluent.controlcenter.kafka.production-nyc.bootstrap.servers を使用すると、Control Center が production-nyc という名前の追加のクラスターをクラスターリストに表示します。

  • 型: list
  • デフォルト: ""
  • 重要度: 高
confluent.controlcenter.kafka.<name>.<connection config>

<name> によって識別された Kafka クラスターに接続するために必要な追加の接続構成は、confluent.controlcenter.kafka.<name>. プレフィックスを使用して指定できます。たとえば、production-nyc というクラスター用に security.protocol=SASL_SSL 構成を指定するには、confluent.controlcenter.kafka.production-nyc.security.protocol=SASL_SSL を構成に追加します。

  • 重要度: 中

ちなみに

マルチクラスターのデプロイを構成している場合は、「confluent.controlcenter.streams.name.cprest.url」も参照してください。

ログ記録

デフォルトでは、Control Center はログを stdout に出力します。ログ記録の構成は etc/confluent-control-center/log4j.properties 内に定義されています。Confluent では、管理の簡単なローリングログファイルで Control Center をセットアップする一例として etc/confluent-control-center/log4j-rolling.properties も提供しています。Control Center の起動時に CONTROL_CENTER_LOG4J_OPTS 環境変数を設定することにより、必要な log4j 構成を選択できます。

オプション設定

Confluent では、内部トピック名、データファイルの場所、レプリケーション設定など、Control Center の動作を変更する他のパラメーターの一部をユーザーが変更できるようにしています。これらの設定の大部分に対するデフォルト値は本稼働環境での使用に適していますが、必要に応じて値を変更できます。

全般

confluent.controlcenter.connect.<connect-cluster-name>.cluster

<connect-cluster-name> によって指定された Connect クラスターの Kafka Connect ワーカー URL のコンマ区切りリストです。<connect-cluster-name には、個々の connect クラスターの識別に使用する任意の文字列を指定できます。ワーカーの設定と対応している必要はありません。Control Center は単一のワーカーに接続することになります。ワーカーの 1 つに障害がある場合、Control Center では別のワーカーに対してリクエストを試行します。Connect クラスターを管理する場合は、このプロパティを設定する必要があります。URL にはプロトコル(HTTP または HTTPS)および関連付けられたポート(それぞれ 8083 または 8443)が含まれている必要があります。

  • 型: list
  • デフォルト: ""
  • 重要度: 高
  • HTTP の例: confluent.controlcenter.connect.myconnectclustername.cluster=http://localhost:8083
confluent.controlcenter.data.dir

Control Center 固有のデータの場所です。このディレクトリに保管されたデータを再計算することはできますが、再計算は高コストであり、Control Center のストリームモニタリング機能の可用性に影響する場合があります。本稼働環境では、耐久性があり、書き込み可能で、セキュアな場所を設定する必要があります。

  • 型: path
  • デフォルト : /var/lib/confluent-control-centercontrol-center-production.properties
  • デフォルト : /tmp/confluent/control-centercontrol-center.propertiescontrol-center-dev.propertiescontrol-center-minimal.properties
  • 重要度: 高
confluent.controlcenter.rest.listeners

http または https で API リクエストをリッスンするリスナーのコンマ区切りリストです。リスナーが https を使用する場合は、適切な SSL 構成パラメーターも設定する必要があります。最初の値は、Control Center から送信される有効なアラートメールの本文で Control Center リンクとして使用されます。詳細については、「アラート履歴」を参照してください。

  • 型: list
  • デフォルト : http://0.0.0.0:9021
  • 重要度: 高
confluent.controlcenter.rest.advertised.url

外部に公開されるホストです。Control Center では、アラートメールなどの外部通信用に URL を生成する際に、rest.listeners のオーバーライドとしてこの値を使用します。

  • 型: string
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.rest.access.control.allow.origin

Jetty の Access-Control-Allow-Origin ヘッダーの値を設定します。

  • 型: string
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.rest.response.http.headers.config

Confluent Platform コンポーネントの HTTP 応答で返す HTTP ヘッダーを選択する目的で使用します。複数の値は、[action][header name]:[header value] 形式のコンマ区切り文字列で指定します。ここで [action] は、setaddsetDateaddDate のいずれかになります。ヘッダーの値にコンマが含まれている場合は、その値を引用符で囲む必要があります。以下に例を示します。

response.http.headers.config="add Cache-Control: no-cache, no-store, must-revalidate", add X-XSS-Protection: 1; mode=block, add Strict-Transport-Security: max-age=31536000; includeSubDomains, add X-Content-Type-Options: nosniff
  • 型: string
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.streams.cprest.url

ブローカー上の HTTP サーバーを有効にするために Control Center 用の REST エンドポイントを定義します。複数のブローカークラスターには、複数の値を持つコンマ区切りリストを指定できます。

例については、「REST エンドポイントとアドバタイズされたリスナーを使用する Control Center の構成」、「Control Center の必須構成」、および Self-Balancing Clusters のドキュメントを参照してください。

  • 型: list
  • デフォルト: http://localhost:8090
  • 重要度: 高

マルチクラスターのデプロイを構成する場合は、「confluent.controlcenter.kafka.name.cprest.url」を参照してください。

confluent.controlcenter.kafka.<name>.cprest.url

ブローカー上の HTTP サーバーを有効にするために、Control Center によってモニタリングされている Kafka クラスターが他にあればその REST エンドポイントを定義します。<name> は、このクラスターを示す名前で置き換えます。この名前は、他の Control Center 構成で使用される Kafka クラスター名と一致している必要があります。複数のブローカークラスターには、複数の値を持つコンマ区切りリストを指定できます。

REST API のエンドポイントのセキュリティに SSL が使用されている場合、セキュリティ情報を提供するプロパティを別途 Confluent Control Center のプロパティファイルに追加する必要がある点に注意してください。詳細については、「UI HTTPS」および「HTTPS 設定」を参照してください。

以下の例では、3 つのクラスターまたはデータセンター(dc1、dc2、dc3)用の REST エンドポイントを指定しています。

confluent.controlcenter.streams.cprest.url=https://dc1:8090
confluent.controlcenter.kafka.dc2.cprest.url=https://dc2:8090
confluent.controlcenter.kafka.dc3.cprest.url=https://dc3:8090
  • 型: list
  • デフォルト: ""
  • 重要度: 高

特に複数のクラスターに対して Control Center の cprest.url を構成する例については、「マルチクラスター Schema Registry の有効化」を参照してください。

confluent.controlcenter.schema.registry.url

Schema Registry URL です。詳細および例については、 Schema Registry のドキュメント と、「マルチクラスター Schema Registry の有効化」の構成手順を参照してください。

confluent.controlcenter.id

Control Center の複数インスタンスが共存できるようにプレフィックスとして使用される識別子です。

  • 型: string
  • デフォルト: "1"
  • 重要度: 低
confluent.controlcenter.name

Control Center の名前

  • 型: string
  • デフォルト : _confluent-controlcenter-6.2.4
  • 重要度: 低
confluent.controlcenter.internal.topics.partitions

Control Center によって内部で使用されるパーティションの数です。

  • 型: int
  • デフォルト: 12
  • 重要度: 低
confluent.controlcenter.internal.topics.replication

Control Center によって内部で使用されるレプリケーション係数です。開発環境を除き、この値を小さくすることはお勧めできません。

  • 型: int
  • デフォルト値: 3
  • 重要度: 低
confluent.controlcenter.internal.topics.retention.ms

Kafka に内部データを保管する、ミリ秒単位の最大時間です。詳しくは、「データの保持」を参照してください。

  • 型: long
  • デフォルト: 604800000(7 日間)
  • 重要度: 低
confluent.controlcenter.internal.topics.changelog.segment.bytes

Kafka の内部 changelog トピックに適用するバイト単位のセグメントサイズです。この値はブローカー設定の log.cleaner.dedupe.buffer.size / log.cleaner.threads と同じ程度に小さくする必要があります。これは、圧縮が機能するようブローカーの重複排除バッファに十分なスペースを確保するためです。

  • 型: long
  • デフォルト: 134217728
  • 重要度: 低
confluent.metrics.topic

メトリクスデータの読み取り元のトピックです。Control Center の複数インスタンスがモニタリング目的で同じ Kafka クラスターを使用している場合は、個別のメトリクスおよびコマンドトピックを使用すると有用なことがあります(各 Control Center インストールで異なる Kafka クラスターをモニタリングしている場合)。

  • 型: string
  • デフォルト値: _confluent-metrics
  • 重要度: 低
confluent.metrics.topic.retention.ms

Kafka にメトリクスデータを保管する、ミリ秒単位の最大時間です。詳しくは、「データの保持」を参照してください。

  • 型: long
  • デフォルト: 259200000(3 日間)
  • 重要度: 低
confluent.metrics.topic.replication

メトリクストピックのレプリケーション係数です。開発環境を除き、この値を小さくすることはお勧めできません。

  • 型: int
  • デフォルト値: 3
  • 重要度: 低
confluent.metrics.topic.partitions

メトリクストピックのパーティション数

  • 型: int
  • デフォルト: 12
  • 重要度: 低
confluent.metrics.topic.skip.backlog.minutes

ブローカーメトリクスデータに関して x 分よりも古い未処理データをスキップします。最新のオフセットから処理する場合は、0 に設定します。この構成により、メトリクス入力トピックに関して confluent.controlcenter.streams.consumer.auto.offset.reset (非推奨)がオーバーライドされます。

  • 型: long
  • デフォルト: 15
confluent.controlcenter.disk.skew.warning.min.bytes

すべてのブローカーでのディスク使用量の最大差異のしきい値。この値を超えると、ディスク使用量の偏りの警告が発行されます。

  • 型: long
  • デフォルト: 1073741824
  • 重要度: 低
confluent.controlcenter.max.trigger.events.per.alert.config

1 つのアラートに含めるトリガーイベントの最大数です。

  • 型: int
  • デフォルト: 1000
  • 重要度: 低
confluent.support.metrics.enable

サポートメトリクスの収集を有効にします。

  • 型: ブール値
  • デフォルト値: true
confluent.controlcenter.alert.cluster.down.autocreate

Control Center のクラスターダウンアラート用にトリガーおよびメールアクションを自動作成します。詳細については、「Control Center クラスターダウンステータス」を参照してください。

  • 型: ブール値
  • デフォルト: false
  • 重要度: 低
confluent.controlcenter.alert.cluster.down.to.email

Control Center のクラスターがダウンしているときのアラート送信先のメールです。

  • 型: string
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.alert.cluster.down.to.webhookurl.slack

Control Center のクラスターがダウンしているときのアラート投稿先の Slack Webhook URL です。

  • 型: string
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.alert.cluster.down.to.pagerduty.integration.key

Control Center のクラスターがダウンしているときに特定のサービスにアラートを投稿するための PagerDuty 統合キーです。

  • 型: string
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.alert.cluster.down.send.rate

自動作成されたクラスターダウンアラートの 1 時間あたりの送信レートです。デフォルト: 1 時間あたり 12 回(5 分毎)。

  • 型: int
  • デフォルト: 12
  • 重要度: 低
confluent.controlcenter.ui.data.expired.threshold

データが古くなったとみなされる前のしきい値(秒単位)を構成します。デフォルト: 120 秒(2 分)。

  • 型: int
  • デフォルト: 120
  • 重要度: 低
confluent.controlcenter.service.healthcheck.interval.sec

Confluent Platform ノードの正常性の確認に使用される間隔(秒単位)です。これには、ksqlDB、Connect、Schema Registry、REST Proxy、Metadata Service (MDS) が含まれます。

  • 型: int
  • デフォルト: 20
  • 重要度: 低
confluent.controlcenter.request.buffer.size.bytes

HttpClient の RequestBuffer サイズを調整できます。

  • 型: int
  • デフォルト: 10000
  • 重要度: 低

モニタリング設定

これらのオプション設定は、 ストリームモニタリング 機能用です。デフォルトの設定は大部分のユースケースおよび規模に対して有効です。

confluent.monitoring.interceptor.topic

モニタリングインターセプターデータを保管する Kafka トピックです。この設定は、ご使用のアプリケーション内でインターセプターに使用される confluent.monitoring.interceptor.topic 構成と一致する必要があります。Control Center の複数インスタンスを実行しており、クライアントモニタリングインターセプターのデータが同じ Kafka クラスターに対してレポートされている場合を除き、通常はこの設定を変更する必要はありません。

  • 型: string
  • デフォルト: _confluent-monitoring
  • 重要度: 高
confluent.monitoring.interceptor.topic.partitions

モニタリングインターセプターデータトピック用のパーティションの数です。

  • 型: int
  • デフォルト: 12
  • 重要度: 低
confluent.monitoring.interceptor.topic.replication

モニタリングトピックのレプリケーション係数です。開発環境を除き、この値を小さくすることはお勧めできません。

  • 型: int
  • デフォルト値: 3
  • 重要度: 低
confluent.monitoring.interceptor.topic.retention.ms

Kafka にインターセプターデータを保管する、ミリ秒単位の最大時間です。詳しくは、「データの保持」を参照してください。

  • 型: long
  • デフォルト: 259200000(3 日間)
  • 重要度: 低
confluent.monitoring.interceptor.topic.skip.backlog.minutes

モニタリングインターセプターのデータに関して x 分よりも古い未処理データをスキップします。最新のオフセットから処理する場合は、0 に設定します。この構成により、モニタリング入力トピックに関して confluent.controlcenter.streams.consumer.auto.offset.reset (非推奨)がオーバーライドされます。

  • 型: long
  • デフォルト: 15
  • 重要度: 低

UI 認証設定

このオプション設定を使用することにより、Control Center ウェブインターフェイスにアクセスするための認証を有効にして構成できます。認証の構成の詳細については、 UI 認証 のガイドを参照してください。

confluent.controlcenter.rest.authentication.method

使用する認証方式です。使用可能なオプションは、NONE、BASIC、BEARER です。

重要

Control Center で RBAC が有効にされている場合、方式は BEARER である必要があります。詳細については、「Control Center 用の RBAC の構成」を参照してください。

  • 型: string
  • デフォルト: NONE
  • 重要度: 低
confluent.controlcenter.rest.authentication.realm

認証時に Control Center によって使用されるレルムです。

  • 型: string
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.rest.authentication.roles

Control Center へのアクセスを認証されているロールです。

  • 型: string
  • デフォルト : *
  • 重要度: 低
confluent.controlcenter.auth.restricted.roles

アクセスが読み取り専用に制限されているロールのリストです。UI を使用しての編集や作成はできません。Add topic および Edit Topic Configs オプションは無効になっています。ここに追加するロールは、confluent.controlcenter.rest.authentication.roles にも含める必要があります。

  • 型: list
  • デフォルト: ""
  • 重要度: 低

重要

限定ロール(読み取り専用)のユーザーは、以下のユーザーインターフェイス(UI)の機能とオプションは使用できません(表示されません)。

  • コネクターの追加、削除、一時停止、再開
  • コネクターのブラウズ
  • コネクター設定の表示
  • コネクター構成のアップロード
  • アラート(トリガーまたはアクション)の作成、削除、編集
  • ライセンスの編集
  • ブローカーの編集
  • クラスター関連フォームでの送信の実行
  • スキーマの編集、作成、削除
  • データフロークエリの編集
  • トピックの検査
  • KSQL エディターへの入力
  • ksqlDB クエリの実行または停止
  • ksqlDB ストリームまたはテーブルの追加

注釈

きめ細かいアクセス制御が必要な場合は、ロールベースアクセス制御(RBAC) を構成することを検討してください。

confluent.controlcenter.auth.session.expiration.ms

ミリ秒単位でのタイムアウトを示します。これを超えたユーザーセッションは認証サービス(LDAP など)によって再認証する必要があります。デフォルトは 0 で、リクエストごとに認証が行われることを意味します。リクエストごとに LDAP サービスを呼び出さないためにはこの値を大きくします。

  • 型: long
  • デフォルト: 0
  • 重要度: 低

RBAC 設定

Control Center に RBAC を実装するために必要な Metadata Service(MDS)およびその他の設定です。重要な設定の詳細な構成例については、「Control Center 用の RBAC の構成」を参照してください。

confluent.metadata.bootstrap.server.urls

1 台または複数台の RBAC メタデータサーバーに接続できる場所を指定する、有効な URL のコンマ区切りリストです。この構成は Control Center を RBAC 環境内で実行するために必要です。

  • 型: long
  • デフォルト: 0
  • 重要度: 低
confluent.metadata.basic.auth.user.info

USERNAME:PASSWORD としてフォーマットされた、Control Center が代行する RBAC ユーザーの認証情報です。代行には、KafkaStreams の実行、リクエストの認可、他の Confluent Platform サービスとのやり取りが含まれます。この構成は Control Center を RBAC 環境内で実行するために必要です。

  • 型: string
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.auth.bearer.issuer

JWT トークン発行者です。

  • 型: string
  • デフォルト: ""
  • 重要度: 低
public.key.path

JWT トークンを認証するためのパブリックキーのパスです。

  • 型: string
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.auth.bearer.roles.claim

JWT ロールクレームです。

  • 型: string
  • デフォルト: ""
  • 重要度: 低

クラスターレジストリ設定

Confluent Platform バージョン 6.0.1 には、Control Center 用に クラスターレジストリ を有効にするオプションがあります。これにより、RBAC の ロールバインディングを実行しやすくなり、監査ログの記録を一元化できます。

confluent.metadata.cluster.registry.enable

このフラグの値は、cluster registry が有効になっている場合 True です。有効にされている場合、クラスター情報は cluster registry から読み取れられます。

  • 型: ブール値
  • デフォルト: false

注釈

この機能フラグが有効にされている場合、以下のフラグは無視されます。

  • confluent.controlcenter.kafka.<name>.bootstrap.servers
  • confluent.controlcenter.kafka.<name>.<connection config>

このルールに対する例外は、confluent.controlcenter.kafka.<name>.ssl.keystore.location など、追加のフラグを指定する必要がある場合です。

confluent.metadata.cluster.registry.merge.configuration.enable

有効にされている場合は、プロパティファイル内の Kafka クラスター用の構成情報が cluster registry からの情報とマージされます。これにより、ユーザーは、cluster registry に追加できない追加のプロパティを構成できます(例: confluent.controlcenter.kafka.&lt;name&gt;.ssl.keystore.location)。

  • 型: ブール値
  • デフォルト値: true
confluent.controlcenter.purge.stale.cluster.enable

有効にされている場合、Control Center ではコマンドストアからの古くなったクラスター情報をパージします。

  • 型: ブール値
  • デフォルト: false

メール設定

これらのオプション設定により、 アラート によって メールアクション がトリガーされるときに使用される SMTP サーバーおよびアカウントを制御します。

重要

メールアラートの本文には、confluent.controlcenter.rest.listeners プロパティに指定されている最初のホスト名が入力されます。デフォルト値は localhost:9021 です。

confluent.controlcenter.mail.enabled

メールアラートを有効にします。この設定が false の場合は、ウェブユーザーインターフェイスでメールアラートアクションを追加できません。

  • 型: ブール値
  • デフォルト: false
  • 重要度: 低
confluent.controlcenter.mail.host.name

送信 SMTP サーバーのホスト名です。

  • 型: string
  • デフォルト: localhost
  • 重要度: 低
confluent.controlcenter.mail.port

confluent.controlcenter.mail.host.name 上で開く SMTP ポートです。

  • 型: int
  • デフォルト: 587
  • 重要度: 低
confluent.controlcenter.mail.from

Control Center から送信されるメールの送信元アドレスです。

confluent.controlcenter.mail.bounce.address

メッセージバウンス通知を送信するための confluent.controlcenter.mail.from 構成のオーバーライドです。

  • 型: string
  • 重要度: 低
confluent.controlcenter.mail.ssl.checkserveridentity

Forces validation of server's certificate when using STARTTLS or SSL.

  • 型: ブール値
  • デフォルト: false
  • 重要度: 低
confluent.controlcenter.mail.starttls.required

STARTTLS の使用を強制します。

  • 型: ブール値
  • デフォルト: false
  • 重要度: 低
confluent.controlcenter.mail.username

ユーザー名とパスワードによる認証用のユーザー名です。SMTP サーバーとの認証は、この値が設定されている場合のみ実行されます。

  • 型: string
  • 重要度: 低
confluent.controlcenter.mail.password

ユーザー名とパスワードによる認証用のパスワードです。

  • 型: string
  • 重要度: 低

Webhook 設定

confluent.controlcenter.webhook.enabled

サポートされている Webhook アラートを有効にします。この設定が false の場合は、ウェブユーザーインターフェースで Webhook アラートアクションを追加できません。

  • 型: ブール値
  • デフォルト値: true
  • 重要度: 低

Kafka の暗号化、認証、認可設定

これらの設定により、Control Center と、データを格納している Kafka クラスターの間の認証と認可が制御されます。データには、ストリームモニタリング および システム正常性 のメトリクスと、複数クラスターの Schema Registry が含まれます。Kafka クラスターになんらかのセキュリティ機能を構成した場合は、これらの設定を構成する必要があります。

これらの設定は、confluent.controlcenter.streams. というプレフィックスが付いた、標準の Kafka 認証および認可設定です。

confluent.controlcenter.streams.security.protocol

ブローカーとの通信に使用されるプロトコル。指定可能な値は、PLAINTEXT、SSL、SASL_PLAINTEXT、SASL_SSL です。

  • 型: string
  • デフォルト: PLAINTEXT
  • 重要度: 低
confluent.controlcenter.streams.ssl.keystore.location

キーストアファイルの場所。

  • 型: string
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.streams.ssl.keystore.password

キーストアファイルのストアパスワード。

  • 型: string
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.streams.ssl.key.password

キーストアファイル内のプライベートキーのパスワード。

  • 型: string
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.streams.ssl.truststore.location

トラストストアファイルの場所。

  • 型: string
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.streams.ssl.truststore.password

トラストストアファイルのパスワード。

  • 型: string
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.streams.sasl.mechanism

クライアントの接続に使用される SASL メカニズム。セキュリティプロバイダーを利用できるものであれば、どのメカニズムでも構いません。GSSAPI がデフォルトのメカニズムです。

  • 型: string
  • デフォルト: GSSAPI
  • 重要度: 低
confluent.controlcenter.streams.sasl.kerberos.service.name

Kafka が実行される際の Kerberos プリンシパル名。これは、Kafka の JAAS 構成または Kafka の構成のどちらかで定義できます。

  • 型: string
  • デフォルト: null
  • 重要度: 低
confluent.controlcenter.schema.registry.basic.auth.credentials.source

HTTP 基本認証ヘッダーの認証情報を、単一の Schema Registry クラスターに関して、またはマルチクラスター Schema Registry デプロイ環境における最初の Schema Registry に関して選択する方法を定義します。サポートされる値は、URL、USER_INFO、SASL_INHERIT です。

  • 型: string
  • デフォルト: URL
  • 重要度: 中

注釈

control.center.schema.registry.basic.auth.credentials.source を指定すると、basic.auth.credentials.source が Schema Registry クライアントに渡されます。

confluent.controlcenter.schema.registry.basic.auth.user.info

単一 Schema Registry クラスター、またはマルチクラスター Schema Registry デプロイでの最初の Schema Registry クラスターの HTTP 基本認証のユーザー情報を {username}:{password} の形式で指定します。

  • 型: string
  • デフォルト: ""
  • 重要度: 中
confluent.controlcenter.schema.registry.<name>.basic.auth.credentials.source

マルチクラスター Schema Registry デプロイ環境で Schema Registry クラスターに関する HTTP 基本認証ヘッダーの認証情報を選択する方法を定義します。サポートされる値は、URL、USER_INFO、SASL_INHERIT です。

  • 型: string
  • デフォルト: URL
  • 重要度: 中
confluent.controlcenter.schema.registry.<name>.basic.auth.user.info

マルチクラスター Schema Registry デプロイでの複数 Schema Registry クラスターの HTTP 基本認証のユーザー情報を {username}:{password} の形式で指定します(<name> によって URL のフィールドと関連付けられます)。

  • 型: string
  • デフォルト: ""
  • 重要度: 中

アクセス制御設定

これらの設定により、メッセージ検査、ブローカー構成、ライセンスマネージャー、ksqlDB 概要、Schema Registry などの機能へのアクセスを制御します。設定は、現在の Control Center インストールによって管理されるすべてのクラスターに適用されます。大部分の機能はデフォルトで有効にされます。ただし、従来のシステム正常性およびストリームモニタリングの非推奨のビューは例外です。

confluent.controlcenter.topic.inspection.enable

ユーザーによる トピックの検査 を有効にします。

  • 型: ブール値
  • デフォルト値: true
  • 重要度: 低
confluent.controlcenter.broker.config.edit.enable

ユーザーによる 動的ブローカーの構成設定の編集 を有効にします。

  • 型: ブール値
  • デフォルト値: true
  • 重要度: 低
confluent.controlcenter.license.manager.enable

Control Center で ライセンスマネージャー を有効にします。

  • 型: ブール値
  • デフォルト値: true
  • 重要度: 低
confluent.controlcenter.consumers.view.enable

Control Center で Consumers ビューを有効にします。

  • 型: ブール値
  • デフォルト値: true
  • 重要度: 低
confluent.controlcenter.deprecated.views.enable

非推奨の ストリームモニタリング および システム正常性 のビューを有効にします。

  • 型: ブール値
  • デフォルト: false
  • 重要度: 低

注釈

非推奨のビューにアクセスするには Control Center で RBAC を無効にする必要があります。

confluent.controlcenter.ksql.enable

ユーザーによる ksqlDB GUI へのアクセスを有効にします。

  • 型: ブール値
  • デフォルト値: true
  • 重要度: 低
confluent.controlcenter.schema.registry.enable

ユーザーによる トピックのスキーマを管理する を有効にします。

  • 型: ブール値
  • デフォルト値: true
  • 重要度: 低
confluent.controlcenter.ui.autoupdate.enable

Control Center UI の 自動アップデート を有効にします。

  • 型: ブール値
  • デフォルト値: true
  • 重要度: 低
confluent.controlcenter.usage.data.collection.enable

データの収集は無効であり、このプロパティは、その値にかかわらず一切作用しません。データの収集は、Control Center で有効または無効にします。

  • 型: ブール値
  • デフォルト値: true
  • 重要度: 低
confluent.controlcenter.ui.replicator.monitoring.enable

Control Center UI での Replicator モニタリング を有効にします。

  • 型: ブール値
  • デフォルト値: true
  • 重要度: 低
confluent.controlcenter.ui.controller.chart.enable

Control Center UI の Broker uptime パネル でのアクティブコントローラーチャートの表示を有効にします。

  • 型: ブール値
  • デフォルト: false
  • 重要度: 低

HTTPS 設定

SSL を使用して Control Center へのウェブアクセスをセキュアにしている場合は、以下のプロパティも構成する必要があることがあります。これらのプロパティは任意のセキュアなエンドポイントへの接続にも使用されます。

confluent.controlcenter.rest.listeners

http または https で API リクエストをリッスンするリスナーのコンマ区切りリストです。リスナーが https を使用する場合は、適切な SSL 構成パラメーターも設定する必要があります。最初の値は、Control Center から送信される有効なアラートメールの本文で Control Center リンクとして使用されます。詳細については、「アラート履歴」を参照してください。

  • 型: list
  • デフォルト : http://0.0.0.0:9021
  • 重要度: 高
confluent.controlcenter.rest.ssl.keystore.location

https に使用されます。SSL に使用するキーストアファイルの場所です。

重要

Jetty では、キーストアに保管されているキーの CN が FQDN と一致している必要があります。

  • 型: string
  • デフォルト: ""
  • 重要度: 高
confluent.controlcenter.rest.ssl.keystore.password

https に使用されます。キーストアファイルのストアパスワード。

  • 型: password
  • デフォルト: ""
  • 重要度: 高
confluent.controlcenter.rest.ssl.key.password

https に使用されます。キーストアファイル内のプライベートキーのパスワード。

  • 型: password
  • デフォルト: ""
  • 重要度: 高
confluent.controlcenter.rest.ssl.truststore.location

https に使用されます。トラストストアの場所です。https クライアントの認証にのみ必要となります。

  • 型: string
  • デフォルト: ""
  • 重要度: 高
confluent.controlcenter.rest.ssl.truststore.password

https に使用されます。トラストストアファイルのストアパスワードです。

  • 型: password
  • デフォルト: ""
  • 重要度: 高
confluent.controlcenter.rest.ssl.keystore.type

https に使用されます。キーストアのファイルの種類です。

  • 型: string
  • デフォルト: JKS
  • 重要度: 中
confluent.controlcenter.rest.ssl.truststore.type

https に使用されます。トラストストアファイルの種類です。

  • 型: string
  • デフォルト: JKS
  • 重要度: 中
confluent.controlcenter.rest.ssl.protocol

https に使用されます。SslContextFactory の生成に使用する SSL プロトコルです。

  • 型: string
  • デフォルト: TLS
  • 重要度: 中
confluent.controlcenter.rest.ssl.provider

https に使用されます。SSL セキュリティプロバイダーの名前です。Jetty のデフォルトを使用する場合は空白にします。

  • 型: string
  • デフォルト: ""(Jetty のデフォルト)
  • 重要度: 中
confluent.controlcenter.rest.ssl.client.auth

非推奨です。https に使用されます。サーバーのトラストストアを使用した認証を https クライアントに要求するかどうかを指定します。confluent.controlcenter.rest.ssl.client.authentication の導入によって非推奨になりました。

  • 型: ブール値
  • デフォルト: false
  • 重要度: 中
confluent.controlcenter.rest.ssl.client.authentication

https に使用されます。指定可能な値は、NONE、REQUESTED、REQUIRED のいずれかです。NONE を指定した場合、SSL クライアント認証が無効になります。REQUESTED を指定した場合、SSL クライアント認証はリクエストされますが、必須ではありません。REQUIRED を指定した場合、SSL https クライアントは、サーバーのトラストストアを使用して認証を行う必要があります。この構成は、confluent.controlcenter.rest.ssl.client.auth (非推奨)をオーバーライドします。

  • 型: string
  • デフォルト: NONE
  • 重要度: 中
confluent.controlcenter.rest.ssl.enabled.protocols

https に使用されます。SSL 接続で有効なプロトコルのリスト。コンマ区切りリストです。Jetty のデフォルトを使用する場合は空白にします。

  • 型: list
  • デフォルト: ""(Jetty のデフォルト)
  • 重要度: 中
confluent.controlcenter.rest.ssl.keymanager.algorithm

https に使用されます。SSL 接続のキーマネージャーファクトリで使用されるアルゴリズムです。Jetty のデフォルトを使用する場合は空白にします。

  • 型: string
  • デフォルト: ""(Jetty のデフォルト)
  • 重要度: 低
confluent.controlcenter.rest.ssl.trustmanager.algorithm

https に使用されます。SSL 接続のトラストマネージャーファクトリで使用されるアルゴリズムです。Jetty のデフォルトを使用する場合は空白にします。

  • 型: string
  • デフォルト: ""(Jetty のデフォルト)
  • 重要度: 低
confluent.controlcenter.rest.ssl.cipher.suites

https に使用される SSL 暗号スイートのコンマ区切りリストです。Jetty のデフォルトを使用する場合は空白にします。

重要

こちら にリストされている暗号はサポートされていません。これらは使用しないでください。

  • 型: list
  • デフォルト: ""(Jetty のデフォルト)
  • 重要度: 低
confluent.controlcenter.rest.ssl.endpoint.identification.algorithm

https に使用されます。サーバー証明書を使用してサーバーホスト名を検証するエンドポイント識別アルゴリズムです。Jetty のデフォルトを使用する場合は空白にします。

  • 型: string
  • デフォルト: https
  • 重要度: 低

ksqlDB 設定

Control Center を使用して ksqlDB Server とやり取りできます。このサーバーは Kafka クラスターとは別に実行されます。ksqlDB に関するアクセス制御構成については、「アクセス制御設定」を参照してください。

confluent.controlcenter.ksql.<ksql-cluster-name>.advertised.url

Control Center 上の ksqlDB クラスターにアクセスするためにアドバタイズされた URL のコンマ区切りリストです。<ksql-cluster-name> は、この ksqlDB クラスターを識別するために Control Center で使用する名前で置き換えます。デフォルトでは、confluent.controlcenter.ksql.<ksql-cluster-name>.url に指定された値に設定されます。これらのホスト名は、Control Center 内の ksqlDB ウェブインターフェイスを使用する任意のブラウザーから到達できる必要があります。

たとえば、ksqlDB が外部で解決したりルーティングしたりできない内部 DNS を介して通信している場合は(Docker for Mac 内で実行されている場合など)、ksqlDB を利用できる、外部向けの DNS をブラウザーが解決できるように、アドバタイズされた URL を設定する必要があります。詳細については、「ksqlDB と Confluent Control Center の統合」を参照してください。

  • 型: list
  • デフォルト: ""
  • 重要度: 低
confluent.controlcenter.ksql.<ksql-cluster-name>.url

<ksql-cluster-name> によって指定された ksqlDB クラスターの ksqlDB サーバーのホスト名およびリスナーポートのコンマ区切りリストです。デフォルトでは空です。これらのホスト名は、Control Center がインストールされているマシンから到達できる必要があります。詳細については、「ksqlDB と Confluent Control Center の統合」を参照してください。

  • 型: list
  • デフォルト: ""
  • 重要度: 低

内部 Kafka ストリーム設定

Control Center では Kafka に対してデータの読み取りと書き込みを行うため、一部のプロデューサーおよびコンシューマーの構成をユーザーが変更できます。

注意

これらの値の変更は Confluent サポートから助言を受けた場合のみに行うことをお勧めします。

内部で使用される値の例をいくつか示してあります。これらの設定は Control Center によって内部で使用されるプロデューサーおよびコンシューマーの構成に 1 対 1 でマッピングしており、すべてプレフィックス confluent.controlcenter.streams.{producer,consumer}. が使用されています。

confluent.controlcenter.streams.num.stream.threads

ストリーム処理を実行するスレッドの数。

  • 型: int
  • デフォルト: 12
  • 重要度: 低
confluent.controlcenter.streams.retries

Number of times to retry client requests failing with transient errors. Does not apply to producer retries, which are defined using the confluent.controlcenter.streams.producer.retries setting described below.

  • 型: int
  • デフォルト: 整数型の最大値(事実上無制限)
  • 重要度: 低
confluent.controlcenter.streams.producer.retries

生成の失敗時の再試行回数です。

  • 型: int
  • デフォルト: 整数型の最大値(事実上無制限)
  • 重要度: 低
confluent.controlcenter.streams.producer.retry.backoff.ms

生成の失敗時の再試行前待機時間です。

  • 型: long
  • デフォルト: 100
  • 重要度: 低
confluent.controlcenter.streams.producer.compression.type

内部トピック生成で使用する圧縮タイプです。

  • 型: string
  • デフォルト: lz4
  • 重要度: 低

内部コマンド設定

コマンドトピックは、Control Center の内部構成データの保管に使用されます。

注釈

Control Center の複数インスタンスがモニタリング目的で同じ Kafka クラスターを使用している場合は、個別のメトリクスおよびコマンドトピックを使用すると有用なことがあります(各 Control Center インストールで異なる Kafka クラスターをモニタリングしている場合)。

コマンドトピックでは、 Kafka Streams のデフォルトまたはオーバーライドが再利用されますが、以下をオーバーライドできます。

confluent.controlcenter.command.topic

Control Center 構成を保管するために使用されるトピックです。

  • 型: string
  • デフォルト: _confluent-command
  • 重要度: 低
confluent.controlcenter.command.topic.replication

コマンドトピックのレプリケーション係数です。

重要

開発環境を除き、レプリケーション値を小さくすることはお勧めできません。

  • 型: int
  • デフォルト値: 3
  • 重要度: 低
confluent.controlcenter.command.topic.retention.ms

Kafka にコマンドデータを保管する、ミリ秒単位の最大時間です。詳しくは、「データの保持」を参照してください。

  • 型: long
  • デフォルト: 86400000(1 日間)
  • 重要度: 低

コンシューマーグループ設定

Consumer Group ページがデータを返していない場合は、ページのタイムアウト値を変更できます。デフォルト値は 15 秒(15000 ミリ秒)です。タイムアウトの問題が発生している場合は、この値を 30 秒(30000 ミリ秒)まで大きくしてみてください。

confluent.controlcenter.consumer.metadata.timeout.ms

コンシューマーグループメタデータの取得を試行しているときの待機時間です。

  • 型: int
  • デフォルト値: 15000
  • 重要度: 低