-
Notifications
You must be signed in to change notification settings - Fork 104
docs: Update KMS docs #1204
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Update KMS docs #1204
Conversation
Vercel Previews Deployed
|
Broken Link CheckerNo broken links found! 🎉 |
| This example shows an IBM KMS stanza in the Boundary configuration file: | ||
|
|
||
| ````hcl | ||
| kms "ibmkp" { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mikemountain @dkanney I'm a little confused about the naming conventions. Was it intentional to go with ibmkp instead of ibmkms? What convention do other kms's go with?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's how the package is named/exported in the the wrapper itself
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok. To maintain consistency, I think we need to rename the header above from
# ibmkms KMS
-->
# ibmkp KMS
cc: @Dan-Heath
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, that makes sense. Thanks @moduli ! Just updated it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similarly, I don't know if that affects anything in docs-nav-data.json?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I updated the navigation pane to reflect the proper product names and make all the KMS provider names consistent. Thanks for thinking that through with me!
This PR updates the Boundary KMS docs.
View the update in the preview deployment: