Update some annotations and defaults

Signed-off-by: reyesj2 <94730068+reyesj2@users.noreply.github.com>
This commit is contained in:
reyesj2
2024-05-29 16:41:02 -04:00
parent 876d860488
commit d9ec556061
2 changed files with 12 additions and 5 deletions

View File

@@ -50,4 +50,9 @@ kafka:
log_x_retention_x_hours: 168
log_x_segment_x_bytes: 1073741824
node_x_id:
process_x_roles: controller
process_x_roles: controller
ssl_x_keystore_x_location: /etc/pki/kafka.p12
ssl_x_keystore_x_type: PKCS12
ssl_x_keystore_x_password: changeit
ssl_x_truststore_x_location: /etc/pki/java/sos/cacerts
ssl_x_truststore_x_password: changeit

View File

@@ -1,6 +1,6 @@
kafka:
enabled:
description: Enable or disable Kafka.
description: Enable or disable Kafka. Recommended to have desired configuration staged prior to enabling Kafka. Join all receiver nodes to grid that will be converted to Kafka nodes, configure kafka_controllers with the hostnames of the nodes you want to act as controllers, and configure the default_replication_factor to the desired value for your redundancy needs.
helpLink: kafka.html
cluster_id:
description: The ID of the Kafka cluster.
@@ -13,7 +13,9 @@ kafka:
sensitive: True
helpLink: kafka.html
kafka_controllers:
description: A list of Security Onion grid members that should act as KRaft controllers for this Kafka cluster. By default, the grid manager will use a 'combined' role where it will act as both a broker and controller. All other nodes will default to broker roles.
description: A list of Security Onion grid members that should act as controllers for this Kafka cluster. By default, the grid manager will use a 'combined' role where it will act as both a broker and controller. Keep total Kafka controllers to an odd number and ensure you do not assign ALL your Kafka nodes as controllers or this Kafka cluster will not start.
forcedType: "[]string"
multiline: True
helpLink: kafka.html
config:
broker:
@@ -27,7 +29,7 @@ kafka:
forcedType: bool
helpLink: kafka.html
default_x_replication_x_factor:
description: The default replication factor for automatically created topics.
description: The default replication factor for automatically created topics. This value must be less than the amount of brokers in the cluster. Hosts specified in kafka_controllers should not be counted towards total broker count.
title: default.replication.factor
forcedType: int
helpLink: kafka.html
@@ -198,7 +200,7 @@ kafka:
forcedType: int
helpLink: kafka.html
process_x_roles:
description: The role performed by KRaft controller node.
description: The role performed by controller node.
title: process.roles
readonly: True
helpLink: kafka.html