Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Connect/KStreams: rename existing tutorial to differentiate from upcoming tutorial

See original GitHub issue

Issue Description

JDBC source connector does not add a key but most KStreams operations require a key.

The key can be added in one of two places:

In Kafka Streams: captured by KT https://github.com/confluentinc/kafka-tutorials/issues/123 (done)
In the Connect framework with an SMT: captured by KT https://github.com/confluentinc/kafka-tutorials/issues/122 (open)

However, the naming of the first tutorial (which is already done and live) is too broad and cannot be differentiated from the new tutorial. It doesn’t specify

(a) where the key is added (KStreams vs Connect) (b) the format (SpecificAvro vs JSON)

This GH issue is to rename the existing tutorial to be more specific, to disambiguate from the other tutorial (and future tutorials)

Initial proposal:

Rename the existing one at https://github.com/confluentinc/kafka-tutorials/issues/123 to connect-jdbc-kstreams-rekey-specificavro, with similar title
Name the new one at https://github.com/confluentinc/kafka-tutorials/issues/122 to connect-jdbc-rekey-smt-kstreams-json, with similar title

Issue Analytics

State:
Created 3 years ago
Comments:9 (9 by maintainers)

Top GitHub Comments

2reactions

colinhickscommented, Mar 19, 2020

@rmoff, given the constraints of the site structure and the existing content patterns, I think combining these tutorials makes the most sense.

With the tabs at the top of the combined tutorial in mind, we’d have:

Kafka Streams: #123 (done)
- uses the JDBC connector and adds the key with KStreams
Kafka: #122 (open)
- uses a connector and adds the key with SMT
ksqlDB #291 (open)
- wraps a connector and adds the key with ksql

So should we reframe the existing tutorial [#123] to make it generic in referencing to the Kafka Connect source …?

Yes. If we need to add more, specific introductory material to the KStreams tutorial, we can create an optional space for that content in the template, which would be displayed only in the Kafka Streams flavor.

I guess I just label it as kafka since it technically is Apache Kafka?

Yeah, this is a bit awkward, but I agree it’s the best bet given the options.

shortname: connect-source-smt-set-key

SEO slug: add-key-to-topic-with-kafka-connect-smt

Tutorial title: Add a key to a stream from Kafka Connect

Seems good to me.

How does this sound overall? Thoughts @ybyzek?

0reactions

rmoffcommented, Mar 26, 2020

#299 closes this.