-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
[DOC] Add new section on Kafka Bridge #1668
Conversation
Co-Authored-By: seanhuck <shuck@redhat.com>
I decided to create a new concept on "Requests to the Kafka Bridge". @ppatierno - Please review the new content on "Data formats and headers": documentation/book/con-requests-kafka-bridge.adoc |
Co-Authored-By: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com>
@ppatierno - Please can you give this a final check and confirm if it's ready to merge? |
@scholzj - Please can you give this a second review and confirm if it's ready to merge? I made the change in terminology to "HTTP clients" as you suggested in PR#51. I've included your content on "Securing the HTTP Kafka Bridge" and "Accessing the HTTP Kafka Bridge from outside of Kubernetes/Openshift". Thanks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some minors. But LGTM otherwise.
---- | ||
# ... | ||
selector: | ||
strimzi.io/cluster: kafka-bridge-name |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The kafka-bridge-name
has to be replaced by the actual name of the CR. Do we will mark the things which should be replaced as <kafka-bridge-name>
? Or just mark it with this <1>
and explain below it how it should be replaced like you do on other places.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we're a bit inconsistent in our approach. I like using annotations in the YAML examples. I'll add a <1>
annotation and an explanation.
|
||
Internal clients can access the Kafka Bridge on the host and port defined in the `KafkaBridge` custom resource. External clients can access the Kafka Bridge by using an {OpenShiftName} route or a LoadBalancer Service. | ||
|
||
For more information on configuring the host and port for the `KafkaBridge` resource, see xref:ref-kafka-bridge-http-configuration-{context}[]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we link here also to con-accessing-kafka-bridge-from-outside-{context}
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed. I'll add an Additional resources section to the module.
Type of change
Description
This pull request adds a new chapter on the Strimzi Kafka Bridge to introduce the Bridge and provide information on clients, data formats, encryption, etc.
The content links to the new content in #1665 where appropriate.
Deploying the Bridge will be documented in a separate PR as this will be documented in chapter 2, Getting Started.
Checklist
Please go through this checklist and make sure all applicable tasks have been done
./design