@itentialopensource/adapter-kafkav2 0.6.4 → 0.6.6

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.6.6 [05-19-2023]
+
+* added support for separate topics files per adapter
+
+See merge request itentialopensource/adapters/notification-messaging/adapter-kafkav2!5
+
+---
+
+## 0.6.5 [05-19-2023]
+
+* added support for separate topics files per adapter
+
+See merge request itentialopensource/adapters/notification-messaging/adapter-kafkav2!5
+
+---
+
 ## 0.6.4 [05-19-2023]
 
 * added support for separate topics files per adapter

package/README.md

@@ -92,6 +92,10 @@ This section defines **all** the properties that are available for the adapter,
     "check_ops_manager_status": false,
     "iap_apps_check_interval": 15000,
     "client": {
+      "brokers": [
+          "broker:9093"
+        ],
+      "clientId": "my-app",
       "connectTimeout": 10000,
       "requestTimeout": 30000,
       "autoConnect": true,
@@ -120,6 +124,20 @@ This section defines **all** the properties that are available for the adapter,
     }
   }
 ```
+Sample SSL and SASL properties. In the below example ssl is enabled and needs a CA file, SASL is set to scram-sha-512.
+
+```json
+"ssl": {
+          "enableTrace": true,
+          "ca": "/path/to/crt.pem",
+          "rejectUnauthorized": true
+        },
+"sasl": {
+          "username": "my-user",
+          "password": "my-password",
+          "mechanism": "scram-sha-512"
+        }
+```
 
 ### Topic Properties
 
@@ -240,13 +258,11 @@ Note that you can pass multiple partitions to be consumed under the same subscri
 ### Connection Properties
 
 These base properties are used to connect to Kafka upon the adapter initially coming up. It is important to set these properties appropriately.
-Kafka server location is set either by providing (host, port) tuple or by providing hostList property
 
 | Property | Description |
 | ------- | ------- |
 | host | Optional. A fully qualified domain name or IP address.|
 | port | Required if `host` set. Used to connect to the server.|
-| hostList | Optional. A string of kafka broker/host combination delimited by comma|
 | interval_time | Optional. The Kafka adapter keeps information about topics and offsets in memory in order to be more efficient. In order to work across restarts the adapter must persist the data. So the data is written into the .topics.json file. This write time defines how often to write the file.|
 | stub | Optional. Slightlu different meaning than normal, this is just telling the adapter whether to run the write topics interval. This should always be false unless you are running standalone tests.|
 
@@ -261,15 +277,10 @@ The following properties are used to define the Kafka Client. These properties a
 
 | Property | Description |
 | ------- | ------- |
-| connectTimeout | ms it takes to wait for a successful connection before moving to the next host.|
-| requestTimeout | ms for a kafka request to timeout .|
-| autoConnect | automatically connect when KafkaClient is instantiated otherwise you need to manually call connect.|
-| connectRetryOptions | object hash that applies to the initial connection.|
-| idleConnection | ms before allowing the broker to disconnect an idle connection from a client. |
-| reconnectOnIdle |  when the connection is closed due to client idling, client will attempt to auto-reconnect.|
-| maxAsyncRequests | maximum async operations at a time toward the kafka cluster..|
+| brokers | kafka broker:port list |
+| clientId | Client-id is a logical grouping of clients with a meaningful name chosen by the client application |
 | ssl | Object, options to be passed to the tls broker sockets, ex. { rejectUnauthorized: false }.|
-| sasl | Object, SASL authentication configuration (only SASL/PLAIN is currently supported), ex. { mechanism: 'plain', username: 'foo', password: 'bar' }.|
+| sasl | Object, SASL authentication configuration (Currently, supports PLAIN, SCRAM-SHA-256, SCRAM-SHA-512), ex. { mechanism: 'plain', username: 'foo', password: 'bar' }.|
 
 ### Producer Properties
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-kafkav2",
-  "version": "0.6.4",
+  "version": "0.6.6",
   "description": "Itential adapter to connect to kafka",
   "main": "adapter.js",
   "wizardVersion": "2.35.0",