From 73acfbf86486e4b0f9a212655641ebfee65eeb35 Mon Sep 17 00:00:00 2001 From: reyesj2 <94730068+reyesj2@users.noreply.github.com> Date: Thu, 20 Jun 2024 16:02:45 -0400 Subject: [PATCH 1/2] update kafka annotations Signed-off-by: reyesj2 <94730068+reyesj2@users.noreply.github.com> --- salt/kafka/soc_kafka.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/salt/kafka/soc_kafka.yaml b/salt/kafka/soc_kafka.yaml index 1172fc5b9..49d633a0f 100644 --- a/salt/kafka/soc_kafka.yaml +++ b/salt/kafka/soc_kafka.yaml @@ -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: From 2eea67185791eb8f336eba07a65bc856d656b973 Mon Sep 17 00:00:00 2001 From: reyesj2 <94730068+reyesj2@users.noreply.github.com> Date: Thu, 20 Jun 2024 16:16:55 -0400 Subject: [PATCH 2/2] more precise wording in kafka annotation Signed-off-by: reyesj2 <94730068+reyesj2@users.noreply.github.com> --- salt/kafka/soc_kafka.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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: