diff --git a/salt/kafka/soc_kafka.yaml b/salt/kafka/soc_kafka.yaml index 49d633a0f..0c9c8a57e 100644 --- a/salt/kafka/soc_kafka.yaml +++ b/salt/kafka/soc_kafka.yaml @@ -1,6 +1,6 @@ kafka: enabled: - 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. + description: Set to True to enable Kafka. To avoid grid problems, do not enable Kafka until the related configuration is in place. Requires a valid Security Onion license key. 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-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. + 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 requiring manual intervention to restore functionality or reset Kafka, either of which can result in data loss. forcedType: "string" helpLink: kafka.html reset: