Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

simplify and clarify documentation for local development #85

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

simplify and clarify documentation for local development #85

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions kafka-java-console-sample/docs/Local.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,15 +94,14 @@ We will not discuss establishing a connection from your laptop to Event Streams

The `java -jar ./build/libs/kafka-java-console-sample-2.0.jar` part of the command identifies the locations of the .JAR file to run within the cloned repository. You do not need to change this.

Use the `kafka_brokers_sasl` from the **Service credentials** created in Step 2. We recommend using all the `kafka_brokers_sasl` listed in the **Service credentials** that you created.
Use the `kafka_brokers_sasl` from the **Service credentials** created in Step 2. We recommend using only one of the `kafka_brokers_sasl` at first and then growing to multiple brokers later, this makes running the samples much simpler however it is important to use all the `kafka_brokers_sasl` in your production workloads
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Gorgonx7, what's your thinking behind this recommendation? Is it that the kafka_brokers_sasl property is annoying to combine into the right format? If so, I think the recommendation should be to use the (new-ish) bootstrap_endpoints property - which is already formatted in an appropriate way.

I'm reluctant to suggest "only use a single bootstrap endpoint", even for initial testing, as I think it is something that's easily forgotten about (at least until it becomes a problem).


>The `kafka_brokers_sasl` must be formatted as `"host:port,host2:port2"`. </br> Format the contents of `kafka_brokers_sasl` in a text editor before entering it in the command line.
>The `kafka_brokers_sasl` must be formatted as `"host:port,host2:port2"`. </br> Format the contents of `kafka_brokers_sasl` in a text editor before entering it in the command line.

Then, use the `api_key` from the **Service credentials** created in Step 2. `-consumer` specifies that the consumer should start.

```
java -jar ./build/libs/kafka-java-console-sample-2.0.jar
<kafka_brokers_sasl> <api_key> -consumer
java -jar ./build/libs/kafka-java-console-sample-2.0.jar "kafka_brokers_sasl_host:port" "api_key" -consumer
```

An `INFO No messages consumed` is displayed when the consuming application is running, but there is no data being consumed.
Expand All @@ -122,8 +121,7 @@ We will not discuss establishing a connection from your laptop to Event Streams
Use the `api_key` from the **Service credentials** created in Step 2. `-producer` specifies that the producer should start.

```
java -jar ./build/libs/kafka-java-console-sample-2.0.jar
<kafka_brokers_sasl> <api_key> -producer
java -jar ./build/libs/kafka-java-console-sample-2.0.jar "kafka_brokers_sasl_host:port" "api_key" -producer
```

---
Expand Down