From d486cb06fa6d07c1e7b180e3530485b62716b358 Mon Sep 17 00:00:00 2001
From: Hunter Madison <hunter.madison@ibm.com>
Date: Wed, 1 May 2024 09:35:22 -0500
Subject: [PATCH] Add a Readme and Owners

Signed-off-by: Hunter Madison <hunter.madison@ibm.com>
---
 plugins/kafka/OWNERS    |  2 ++
 plugins/kafka/README.md | 57 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 59 insertions(+)
 create mode 100644 plugins/kafka/OWNERS
 create mode 100644 plugins/kafka/README.md

diff --git a/plugins/kafka/OWNERS b/plugins/kafka/OWNERS
new file mode 100644
index 00000000..0fb2e607
--- /dev/null
+++ b/plugins/kafka/OWNERS
@@ -0,0 +1,2 @@
+reviewers:
+  - hmadison
\ No newline at end of file
diff --git a/plugins/kafka/README.md b/plugins/kafka/README.md
new file mode 100644
index 00000000..fee14ce0
--- /dev/null
+++ b/plugins/kafka/README.md
@@ -0,0 +1,57 @@
+# Kafka Events Plugin
+
+This repository contains the `kafka` plugin for `Falco`.
+
+# Event Source
+
+The event source for `kafka` events is `kafka`.
+
+# Supported Fields
+
+This plugin does not provide field extraction.
+
+# Development
+## Requirements
+
+You need:
+* `Go` >= 1.22.2
+
+## Build
+
+```shell
+make
+```
+
+# Settings
+
+Only `init` accepts settings:
+
+* `brokers`: The list of Kafka brokers to consume messages from.
+* `groupId`: The consumer group identifier.
+* `topics`: The topics to consume from.
+* `tlsConfig`: Configuration for TLS encryption.
+
+# Configurations
+
+* `falco.yaml`
+
+  ```yaml
+  plugins:
+    - name: kafka
+      library_path: /usr/share/falco/plugins/libkafka.so
+      init_config:
+        init_config: |
+          {
+            "brokers": ["host.docker.internal:9094"],
+            "topics": ["example2"],
+            "groupId": "example1",
+            "tlsConfig": {
+              "caCertPath": "/mnt/certs/ca.pem",
+              "userCertPath": "/mnt/certs/user.pem",
+              "userKeyPath": "/mnt/certs/key.pem"
+            }
+          }
+      open_params: ''
+
+  load_plugins: [kafka]
+  ```
\ No newline at end of file