Updates to the architecture Registry section, and other misc #233
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
* Make the architecture venn diagram less enormous. IMHO it doesn't really say much, but this way it doesn't take up most of the page above the fold. * There used to be two "A Network Service is..." sentences. I removed one. * Other text tweaks. Signed-off-by: Toby Cabot <[email protected]>
This is triggered by the conversation at https://cloud-native.slack.com/archives/CHSKJ4849/p1663793722639479 The main improvement from this patch is better clarity on the different types of registry, and how other components interact with the registry. Signed-off-by: Toby Cabot <[email protected]>
While I was editing the architecture page to update the Registry section I noticed some other fixes. Signed-off-by: Toby Cabot <[email protected]>
ghost
force-pushed
the
registry-updates
branch
from
3202791 to
4290310
Compare
|
...and I've now set up magit to add "signed-off-by" by default so hopefully there will be less force-pushing in my life. |
edwarnicke
reviewed
Sep 23, 2022
edwarnicke
reviewed
Sep 23, 2022
|
@acnodal-tc Overall this is a vast improvement. I added a few comments adding color. I look forward to seeing what you will do with them :) |
* Link to the Registry gRPC proto to indicate that the current implementations aren't the only possible ones. Also a few other improvements: * Link to cmd-registry source repos * Rearrange Registry sections to better match the "Key Concepts" flow Signed-off-by: Toby Cabot <[email protected]>
... and use "gRPC" on this page since that's how Google spells it. Signed-off-by: Toby Cabot <[email protected]>
Moved the Endpoints section higher so we define both Clients and Endpoints before vWires since vWires depend on the other concepts. Signed-off-by: Toby Cabot <[email protected]>
|
I pushed a few updates that hopefully help. |
Signed-off-by: Toby Cabot <[email protected]>
denis-tingaikin
approved these changes
Nov 15, 2022
edwarnicke
reviewed
Jan 9, 2023
|
|
||
| A {{<color "#008A00" >}}Network Service Endpoint{{< /color >}} ({{<color "#008A00" >}}NSE{{< /color >}} or {{<color "#008A00" >}}Endpoint{{< /color >}}) provides one or more Network Services. It registers with the registry a list | ||
| of Network Services (by name) that it provides, and the 'destination labels' it is advertising for each Network Service. | ||
| Clients and Endpoints don't connect directly to the Registry; they connect to the [Network Service Manager](https://github.com/networkservicemesh/cmd-nsmgr) which acts as a proxy for the registry. This simplifies NSM's internal data flows since Clients and Endpoints need to connect to the Manager anyway. |
There was a problem hiding this comment.
Suggested change
| Clients and Endpoints don't connect directly to the Registry; they connect to the [Network Service Manager](https://github.com/networkservicemesh/cmd-nsmgr) which acts as a proxy for the registry. This simplifies NSM's internal data flows since Clients and Endpoints need to connect to the Manager anyway. | |
| In K8s Clients and Endpoints don't connect directly to the Registry; they connect to the [Network Service Manager](https://github.com/networkservicemesh/cmd-nsmgr) which acts as a proxy for the registry. This simplifies NSM's internal data flows since Clients and Endpoints need to connect to the Manager anyway. |
There was a problem hiding this comment.
It might make more sense to move this into the K8s tabs, as its a feature of the K8s implementation of NSM, not a fundamental part of the base architecture.
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.
This is triggered by the conversation at
https://cloud-native.slack.com/archives/CHSKJ4849/p1663793722639479
The main improvement from this patch is better clarity on the
different types of registry, and how other components interact with
the registry.