Skip to content
This repository has been archived by the owner on May 25, 2022. It is now read-only.

[DOCS] Kafka Connect and Mirror Maker upgrades, plus minor style edits #48

Merged
merged 9 commits into from May 21, 2019
Merged

[DOCS] Kafka Connect and Mirror Maker upgrades, plus minor style edits #48

merged 9 commits into from May 21, 2019

Conversation

d-laing
Copy link

@d-laing d-laing commented Apr 16, 2019

This pull request clarifies that Kafka Connect and Mirror Maker are just client applications and should be upgraded to the new Kafka version along with other clients. It also makes a few style and wording changes.

You can view the staged documentation on my file share: http://file.rdu.redhat.com/~dlaing/#assembly-upgrade-1-1-0-str

@d-laing
Copy link
Author

d-laing commented Apr 16, 2019

Should this refer to "Kafka Connect connectors" rather than "Kafka Connect"?

books/assembly-upgrade-1-1-0.adoc Outdated Show resolved Hide resolved
books/assembly-upgrade-1-1-0.adoc Outdated Show resolved Hide resolved
@@ -6,7 +6,7 @@

= Strategies for upgrading clients

The best approach to upgrading your client applications (including Kafka Connect connectors) depends on your particular circumstances.
The best approach to upgrading your client applications (producers, consumers, Kafka Connect, and MirrorMaker) depends on your particular circumstances.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above.

@scholzj
Copy link
Contributor

scholzj commented Apr 16, 2019

@laidan6000 Well, it depends what do you want to update. In your text IMHO Kafka Connect is correct.

However, from the title of this PR, I expected that this will have the upgrade guide for Kafka Connect and Kafka Mirror Maker. Which it doesn't. Connect and Mirror maker should really have their own upgrade procedures.

Copy link
Contributor

@PaulRMellor PaulRMellor left a comment

Choose a reason for hiding this comment

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

May need further review if we introduce new procedures.

@@ -6,7 +6,7 @@

= Configuring Kafka brokers to use the new message format version

When client applications have been upgraded, you can update the Kafka brokers to use the new message format version (2.1).
When client applications (producers, consumers, Kafka Connect, and MirrorMaker) have been upgraded, you can update the Kafka brokers to use the new message format version (2.1).
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we use an attribute for this "new message format version", because it's likely to change again in the future and we'll likely forget to update to update all the places it has been used.

Copy link
Author

Choose a reason for hiding this comment

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

I suppose we'd also need an attribute for the inter-broker protocol versions. Given time constraints, I'd rather handle this when we make any necessary changes to this chapter to align with the next downstream release.

@d-laing
Copy link
Author

d-laing commented Apr 17, 2019

@scholzj - Regarding having separate procedures, @tombentley is of the view that Kafka Connect and Mirror Maker do not need separate procedures. We should just highlight that they are types of clients.

@tombentley
Copy link
Contributor

@tombentley is of the view that Kafka Connect and Mirror Maker do not need separate procedures. We should just highlight that they are types of clients.

It's different on OCP, of course, because we're providing the operators for these, so they warrant procedures imho, but on RHEL I don't think it's really necessary.

@scholzj
Copy link
Contributor

scholzj commented Apr 17, 2019

TBH, I do not agree with that. i think we should have a procedure for that on both. Even if it would be just a stupid procedure which would say to change the spec.version property on OCP or unzip the new binaries on RHEL. It would help to remind the users that they should upgrade it as well.

For Mirror Maker it might also tell them how to configure different versions on each side. For Connect it should probably give some advice on what to do with connectors.

@d-laing
Copy link
Author

d-laing commented Apr 24, 2019

Following Jakub's review, I've added a new procedure named "Upgrading Kafka Connect to AMQ Streams 1.1.0". This is mainly based on the existing procedure, "Upgrading Kafka brokers to AMQ Streams 1.1.0".

Decided not to have a standalone procedure for MirrorMaker upgrades because we are lacking in any other documentation on MirrorMaker.

Please review the changes on my file share: http://file.rdu.redhat.com/~dlaing/#assembly-upgrade-1-1-0-str

Co-Authored-By: laidan6000 <dlaing@redhat.com>
@d-laing d-laing merged commit b97d01c into rh-messaging:master May 21, 2019
@d-laing d-laing deleted the kafka-connect-and-mirror-maker-upgrades branch May 21, 2019 10:37
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants