Skip to content

[question] Registry documentation 🧐 #109

@nsergey82

Description

@nsergey82

In #106 we introduce a registry.
While it is indeed implemented as one of the many platforms in our ecosystem, it is also a protocol.
We expect all registry implementations by other vendors to expose the same endpoint.

Hence, the definition of such a protocol even if brief should be either in a separate file or in a separate clearly marked section. Then, the description of the platform can simply state that it implements the protocol.

Now, assuming we are documenting the protocol, and not specifically our implementation:

  1. this is not a tool for "service discovery" -- that is something that consul would say. This a tool to dereference w3ids.
  2. entropy -- I'm still not convinced and we have a parallel discussion in other documents. But if we decide to go it -- it should send back a uuid, not just 20 characters; one hour guarantee is arbitrary -- with that said, we could have a field in the reply stating if there are any guarantees about time of use; finally, it should be stated that any such guarantee is almost certainly local to that registry and not the whole universe of ids.
  3. /.well-known The jwks.json contains key(s) that will be used to sign the result of every resolution (according to @AlexTourski). Not just entropy. Also, worth saying we can trust the content if we access it using a secure channel. But that can of worms we will open later.
  4. /resolve -- remove the mention of consul in the protocol section, but can keep it in the concrete platform section
  5. /resolve -- as said above, the resolution (but probably not 404) needs to be signed 🤷‍♂
  6. /resolve -- it is not returning "service details", but something that can be used directly by a browser or curl or whatever -- ip:port or uri. Effectively, it returns a valid "path" to evault's root / endpoint

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions