Improve README and feature docs #330
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Knappek
force-pushed
the
284-document-sync-async-http-to-kafka
branch
from
f92bce6
to
f149877
Compare
Knappek
force-pushed
the
284-document-sync-async-http-to-kafka
branch
from
baac1cd
to
1ca5c18
Compare
kevinbader
reviewed
Oct 30, 2020
docs/features.md
Outdated
|
|
||
| RIG acts as a fan-out publisher of backend events. Clients can simply subscribe to RIG in order to receive these events. This makes your frontend apps reactive and eliminates the need for polling. | ||
|
|
||
| Additionally clients can provide a filter during the subscription initialization and tell RIG in what type of events it is interested in. Thus, you don't have to implement this filter logic in all of your client applications, RIG takes care of it. |
There was a problem hiding this comment.
Suggested change
| Additionally clients can provide a filter during the subscription initialization and tell RIG in what type of events it is interested in. Thus, you don't have to implement this filter logic in all of your client applications, RIG takes care of it. | |
| Additionally clients can provide filters during the subscription initialization and tell RIG in what type of events it is interested in. Those filters allow clients to tap into high-volume event streams without getting overwhelmed by unwanted events. In other words, filters enable bandwidth efficiency. |
docs/features.md
Outdated
|
|
||
| You may ask: Why shouldn't I directly talk to the backend? What benefits does RIG provide? | ||
|
|
||
| RIG provides many additional features on top like session management or JWT signature verification. You don't have to implement this over and over again at the clients and backend services. |
There was a problem hiding this comment.
Suggested change
| RIG provides many additional features on top like session management or JWT signature verification. You don't have to implement this over and over again at the clients and backend services. | |
| RIG provides many additional features on top like session management or JWT signature verification. You don't have to implement this over and over again at the clients and backend services. That said, it's perfectly fine to run RIG alongside an existing API management gateway, too. |
docs/features.md
Outdated
|
|
||
|  | ||
|
|
||
| This enables an asynchonous communication between client-side applications and the backend. RIG acts as a middle-man handling authentication when communicating to queuing systems. Without RIG, it would be required to have a custom backend applications that handles client requests and forwarding them to Kafka, Nats or Kinesis. This additional backend app is a single source of failure, hence it would be necessary to harden it and make it highly available and reliable. WIth RIG, you don't have to take care of that - RIG is [scalable by design](https://accenture.github.io/reactive-interaction-gateway/docs/features.html#built-in-features). |
There was a problem hiding this comment.
Suggested change
| This enables an asynchonous communication between client-side applications and the backend. RIG acts as a middle-man handling authentication when communicating to queuing systems. Without RIG, it would be required to have a custom backend applications that handles client requests and forwarding them to Kafka, Nats or Kinesis. This additional backend app is a single source of failure, hence it would be necessary to harden it and make it highly available and reliable. WIth RIG, you don't have to take care of that - RIG is [scalable by design](https://accenture.github.io/reactive-interaction-gateway/docs/features.html#built-in-features). | |
| This enables asynchonous communication between client-side applications and the backend. RIG acts as a bridge between its clients and the messaging system. Similar to above, the authenticity of client requests are validated using JWT signature verification. RIG effectively replaces a custom backend application that would accept client requests and forward them to Kafka, Nats or Kinesis. This additional backend app is a single point of failure, hence it would be necessary to harden it and make it highly available and reliable. With RIG, you don't have to take care of that - RIG is [scalable by design](https://accenture.github.io/reactive-interaction-gateway/docs/features.html#built-in-features). |
docs/features.md
Outdated
|
|
||
|  | ||
|
|
||
| This scenario can be quite useful which is described in more detail in the [Architecture section](https://accenture.github.io/reactive-interaction-gateway/docs/architecture.html#providing-a-synchronous-api-for-asynchronous-back-end-services). RIG correlates the corresponding answer using the correlation ID of the oRIGinal request, that will be forwarded to the backend and also being used in the response of the backend. With this ID, RIG can filter the appropriate message from the consuming topic. |
There was a problem hiding this comment.
oRIGinal request
Pun intended? ;D
kevinbader
approved these changes
Nov 11, 2020
|
I am not yet finished, I want to document the feature of integration with external authn/z systems... let's look into the build afterwards... |
perhaps in a new PR? would like to prevent conflicts, e.g. with #338 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR improves the RIG feature documentation. The goal is to have a clean README that explains in short what RIG is about and its main features without going into much details.
close #284
What to look out for
Dear reviewer, I want you to
Process
The goal is to improve not only the code in this PR but also our skills! The "rules":
Have fun!