Docs: Update READMEs for Slack-connector and Report-parser to include…

… a note about bug #139
simplybusiness · Jan 22, 2020 · bcb1bda · bcb1bda
1 parent 3a0dd6a
commit bcb1bda
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/report-parser/README.md b/report-parser/README.md
@@ -10,6 +10,8 @@ See the [suggested Kafka deployment](../docs/suggested_kafka_deployment.md) docu
 
 Tool reports are consumed from to a Kafka topic called "ToolReports" and vulnerable dependency events are published to a topic called "DependencyEvents". If you do not have auto topic creation enabled for your cluster, you will need to create these topics.
 
+**Please note: There is currently a known issue with running this component in a HA configuration, which results in duplicate messages being written to the DependencyEvents Kafka topic. This is being tracked in #139.**
+
 ## Configuration
 This component is configured using environment variables. Ensure that the environment variable `KAFKA_BOOTSTRAP_TLS` is set to a comma separated list of host:port pairs to bootstrap connectivity to your Kafka cluster over TLS.
 

diff --git a/slack-connector/README.md b/slack-connector/README.md
@@ -12,6 +12,8 @@ DependencyEvents are consumed from a Kafka topic called "DependencyEvents". If y
 
 To grant the Slack Connector access to your Slack workspace, you will need to register it as a Slack app for your workspace and generate an access token for it. Instructions for this can be found [here](https://api.slack.com/authentication/basics). Follow those instructions up to and including "Installing the app to a workspace". When you get to the step where you're adding OAuth Scopes, add the following scopes: `channels:read` and `chat:write`. By the end of that step, you should have an OAuth2 Access token for the Slack Connector. It is important that this token is handled carefully, because it grants access to your Slack workspace.
 
+**Please note: There is currently a known issue with running this component in a HA configuration, which results in duplicate messages being posted to Slack. This is being tracked in #139.**
+
 ## Configuration
 This component is configured using environment variables. Ensure that the environment variable `KAFKA_BOOTSTRAP_TLS` is set to a comma separated list of host:port pairs to bootstrap connectivity to your Kafka cluster over TLS.