clusterlink-net / clusterlink

A Gateway for connecting application services in different domains, networks, and cloud infrastructures
https://clusterlink.net
Other
17 stars 18 forks source link

Update peers.md #571

Closed welisheva closed 1 month ago

welisheva commented 2 months ago

Changed a few minor things including hyphens, articles, abbreviations, fonts, subject/verb agreement, made links descriptive, etc. --

Here are a few other comments that I didn't implement because someone needs to think about them:

 Initializing a new peer: • Under info (in orange) – this sentence doesn’t make sense? “You will need the CA certificate (but not the CA private key) and the peer certificate and private in the next step.” Did you mean private key, the second time it’s mentioned? Certificate and private are mentioned twice and seem contradictory or redundant? Could we either take out this sentence or clarify what it meant? • When I read this ” They can be provided out of band (e.g., over email) to the peer administrator.” it comes to mind that I would caution against sending something that is supposed to be private over email. What is the best practice? Perhaps give an explanation?  Deploy ClusterLink to a new peer:This sentence is confusing: “Before proceeding, ensure that the CA certificate (the CA private key is not needed), and the peer certificate and key files which were created in the previous step are in the current working directory.” Reason for the confusion: No need for a private key, but yes need for key files? Public keys? If so is the word “public” worth specifying?  Add or Remove Peers: • Again “out of band” use of email communication encouraged, this time a future way of handling it hinted at, consider again if this is really what you want to advise for now.

elevran commented 2 months ago

Initializing a new peer: • Under info (in orange) – this sentence doesn’t make sense? “You will need the CA certificate (but not the CA private key) and the peer certificate and private in the next step.” Did you mean private key, the second time it’s mentioned? Certificate and private are mentioned twice and seem contradictory or redundant? Could we either take out this sentence or clarify what it meant?

It's missing key in the second part. There are two pairs of certificate (the public key) and private key: one for the "fabric" (the CA) and one for the peer. You need CA certificate and both peer certificate and peer private key.

• When I read this ” They can be provided out of band (e.g., over email) to the peer administrator.” it comes to mind that I would caution against sending something that is supposed to be private over email. What is the best practice? Perhaps give an explanation?

I'm not sure there are really good solutions or best practices for sharing secret information remotely. One could send it encrypted and provide the decryption key over the phone or any other scheme. I would leave it as is for now. With central management (on our roadmap) this would be resolved as the information is retrieved securely from the management plane.

 Deploy ClusterLink to a new peer:This sentence is confusing: “Before proceeding, ensure that the CA certificate (the CA private key is not needed), and the peer certificate and key files which were created in the previous step are in the current working directory.” Reason for the confusion: No need for a private key, but yes need for key files? Public keys? If so is the word “public” worth specifying?

To clarify: the (1) CA certificate, (2) peer certificate and (3) peer private key are needed. The CA private key is not needed in this step. All these three are stored in files which should be available in the local working do Happy to integrate a more clearly written sentence.

 Add or Remove Peers: • Again “out of band” use of email communication encouraged, this time a future way of handling it hinted at, consider again if this is really what you want to advise for now.

I don't see an immediate alternative. Customer should use whatever mechanism they use today for handling similar situations.