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.

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

docs(diagrams): updates digrams to be more kraft friendly #9962

Merged
merged 2 commits into from
Apr 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file modified documentation/shared/images/cluster-operator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/shared/images/kafka-bridge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/shared/images/oauth-introspection-endpoint-long-token.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/shared/images/oauth-introspection-endpoint.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/shared/images/oauth-jwt-signature-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/shared/images/oauth-jwt-signature.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/shared/images/oauth-plain-access-token.png
Copy link
Member

Choose a reason for hiding this comment

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

It is a nit and I'm not sure it is worth changing the image. But all the other OAuth images seem to use Kafka broker. Only this one seems to use Kafka node. Might make sense to use Kafka broker here as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't spot that. We'll change that back.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/shared/images/oauth-plain-client-id.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/shared/images/operators.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/shared/images/secure_communication_kraft.png
Copy link
Member

Choose a reason for hiding this comment

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

The pod numbers here are confusing. Maybe we can remove them for both brokers and controllers and just have multiple squares with Kafka broker pod and Kafka controller pod without the numbers?

(The source of confusion is that you cannot have broker 1 and controller 1 at the same time => so the numbers do not correspond to the actual node IDs. I don't think this is wrong as the number indicates the count, but it might confuse someone. The ZooKeeper based image is fine as the ZooKeeper nodes have their own IDs independent on Kafka. So no need to fix that.)

Copy link
Contributor Author

@PaulRMellor PaulRMellor Apr 15, 2024

Choose a reason for hiding this comment

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

I don't think it's confusing. I wouldn't assume to think we're talking IDs here. I could make this obvious in the surrounding text if we really need to. If we change it, we lose consistency with the zookeeper diagram. What are your thoughts @scholzj?

Copy link
Member

Choose a reason for hiding this comment

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

Well, as I said, I would remove the numbers from the picture. I think it can be confusing because the IDs play a key part and the way they work in KRaft with the same series used for everything is already confusing enough with KRaft based on some Slack questions.

Copy link
Contributor Author

@PaulRMellor PaulRMellor Apr 15, 2024

Choose a reason for hiding this comment

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

Okay. We don't want to cause any confusion. I'll get that updated. Any objections to removing the numbers from the zookeeper diagram for consistency sake?

Copy link
Member

Choose a reason for hiding this comment

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

I would agree with Jakub and I am fine removing the numbers from ZooKeeper diagram as well.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/shared/images/secure_communication_zookeeper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/shared/images/topic-operator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading