adds ssh host key validation usage doc #1476
Conversation
Vercel Previews Deployed
|
Broken Link CheckerNo broken links found! 🎉 |
Dan-Heath
left a comment
Dan-Heath
left a comment
There was a problem hiding this comment.
This looks great! The procedures are easy to follow and understand. The intro provides valuable context about why users might want to use this feature. This is a nice addition to the workers guide.
I added some suggestions for word choice and a thought about the title. Only other thought was that maybe we should mention this or at least put a link in the /boundary/docs/workers main topic. Please let me know if you have any questions or want to chat through any of it.
Thank you for this!
| Learn about configuring SSH host key validation to ensure workers connect to the correct servers and to reduce the risk of man-in-the-middle attacks. | ||
| --- | ||
|
|
||
| # SSH host key validation |
There was a problem hiding this comment.
I think we should make this H1 title start with a verb to convey that it is a usage doc. We could make it "Configure SSH host key validation" like it is in the TOC. But I'm also wondering if there's a better title to convey the job to be done here, like maybe "Verify host identity"?
There was a problem hiding this comment.
great suggestion, I like your title. I updated it to "Verify SSH host identity"
|
|
||
| ## Enable host key validation | ||
|
|
||
| When the known hosts configuration changes, you must restart the worker. |
There was a problem hiding this comment.
You mention the right thing a few sentences below, but you can either restart the worker or SIGHUP it
There was a problem hiding this comment.
thanks 👍 I've fixed this
Dan-Heath
left a comment
Dan-Heath
left a comment
There was a problem hiding this comment.
Looks great, thank you!!
3 participants
This PR adds usage docs for SSH host key validation for the 0.21.0 release. It includes the following updates:
workers/ssh-host-keydata/docs-nav-data.jsonJira: SPE-1385
SSH host key validation deploy preview