CSEC_PUBLIC/securityonion
1
0
Fork 0
mirror of https://github.com/Security-Onion-Solutions/securityonion.git synced 2025-12-06 09:12:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

update kafka annotations

Browse Source 
Signed-off-by: reyesj2 <94730068+reyesj2@users.noreply.github.com>
This commit is contained in:
reyesj2
2024-06-20 16:02:45 -04:00
parent ae0e994461
commit 73acfbf864
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
salt/kafka/soc_kafka.yaml
View File

@@ -1,6 +1,6 @@
kafka:
enabled:
description: Enable or disable Kafka. Recommended to have desired configuration staged prior to enabling Kafka. Configure controllers with the hostnames of the nodes you want to act as controllers, join all receiver nodes to grid that will be converted to Kafka nodes, and configure the default_replication_factor to the desired value for your redundancy needs.
description: Enable or disable Kafka. It is recommended you have desired configuration staged prior to enabling Kafka. Including configuring the assigned controllers, setting topic replication factor, and adjusting Kafka retention.
helpLink: kafka.html
cluster_id:
description: The ID of the Kafka cluster.
@@ -13,7 +13,7 @@ kafka:
sensitive: True
helpLink: kafka.html
controllers:
description: A comma-seperated list of Security Onion hosts that will act as Kafka controllers. These hosts will be responsible for managing the Kafka cluster. WARNING - The hostnames of receiver nodes intended to be controllers should be added here BEFORE they have joined the Security Onion grid or BEFORE enabling KAFKA. This is to ensure that data is not lost by converting a data broker to a controller. Failure to do so may result in topics becoming unavailable and requiring manual intervention to repair or resetting Kafka data.
description: A comma-separated list of hostnames that will act as Kafka controllers. These hosts will be responsible for managing the Kafka cluster. Note that only manager and receiver nodes are eligible to run Kafka. This configuration needs to be set before enabling Kafka. Failure to do so may result in Kafka topics becoming unavailable and requiring manual intervention to restore functionality or resetting Kafka resulting in data loss.
forcedType: "string"
helpLink: kafka.html
reset: