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

[DOC] Add new section on Kafka Bridge #1668

Merged
merged 28 commits into from
Jun 11, 2019
Merged

[DOC] Add new section on Kafka Bridge #1668

merged 28 commits into from
Jun 11, 2019

Conversation

d-laing
Copy link
Member

@d-laing d-laing commented May 31, 2019

Type of change

  • Documentation

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

  • Update/write design documentation in ./design
  • Write tests
  • Make sure all tests pass
  • Update documentation
  • Check RBAC rights for Kubernetes / OpenShift roles
  • Try your changes from Pod inside your Kubernetes and OpenShift cluster, not just locally
  • Reference relevant issue(s) and close them after merging
  • Update CHANGELOG.md

@d-laing
Copy link
Member Author

d-laing commented Jun 3, 2019

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

documentation/book/con-requests-kafka-bridge.adoc Outdated Show resolved Hide resolved
documentation/book/con-requests-kafka-bridge.adoc Outdated Show resolved Hide resolved
documentation/book/con-requests-kafka-bridge.adoc Outdated Show resolved Hide resolved
documentation/book/con-requests-kafka-bridge.adoc Outdated Show resolved Hide resolved
Daniel Laing and others added 2 commits June 7, 2019 14:51
Co-Authored-By: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com>
@strimzi strimzi deleted a comment from PaulRMellor Jun 7, 2019
@strimzi strimzi deleted a comment from PaulRMellor Jun 7, 2019
@strimzi strimzi deleted a comment from PaulRMellor Jun 7, 2019
@strimzi strimzi deleted a comment from PaulRMellor Jun 7, 2019
@d-laing d-laing marked this pull request as ready for review June 10, 2019 10:12
@d-laing d-laing changed the title [DOC, WIP] Add new section on Kafka Bridge [DOC] Add new section on Kafka Bridge Jun 10, 2019
@d-laing
Copy link
Member Author

d-laing commented Jun 10, 2019

  • Removed the unfinished modules and added cross-refs to [DOC] Add new section on Kafka Bridge #1668 where appropriate, e.g. the deployment instructions. I decided to remove the "Sending Requests" module from the scope of this PR.
  • Incorporated Jakub's content on "Securing the HTTP Kafka Bridge".
  • Added a new module for Jakub's content on "Accessing the HTTP Kafka Bridge from outside of Kubernetes/Openshift"

@ppatierno - Please can you give this a final check and confirm if it's ready to merge?

@d-laing
Copy link
Member Author

d-laing commented Jun 10, 2019

@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.

Copy link
Member

@scholzj scholzj left a 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
Copy link
Member

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.

Copy link
Member Author

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}[].
Copy link
Member

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}?

Copy link
Member Author

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.

@d-laing d-laing added the ready for merge Label for PRs which are ready for merge label Jun 11, 2019
@scholzj scholzj merged commit 7ba8f81 into strimzi:master Jun 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation peer-review-done ready for merge Label for PRs which are ready for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants