replace Vault with OpenBao in documentation #44
Merged
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
|
Will take a look at this when I get back! |
joewxboy
suggested changes
Jan 18, 2024
There was a problem hiding this comment.
In summary ...
- Filenames and paths likely use either "openbao" or just "bao" but let's confirrm with the development team. These include cacert, binpath, config, token, and logfiles.
- The hostname is either "openbao-fqdn" or just "bao-fqdn" but I don't know which. Please confirm.
- The CLI (or shell) is definitely just "bao" and not "openbao". Please change all instances.
- Let's NOT change the documentation page filenames and paths just yet. Let's handle that in a separate change. This would also include the section IDs, which appear in the URL past the hash sign (#).
- Let's confirm the service name, display name, and registry key, both to ensure it is "openbao" and not "bao" but also to confirm the case.
website/content/docs/agent-and-proxy/agent/caching/persistent-caches/kubernetes.mdx
Show resolved
Hide resolved
website/content/docs/agent-and-proxy/agent/generate-config/index.mdx
Outdated
Show resolved
Hide resolved
website/content/docs/agent-and-proxy/agent/generate-config/index.mdx
Outdated
Show resolved
Hide resolved
cipherboy
pushed a commit
to cipherboy/openbao
that referenced
this pull request
Jan 21, 2024
Co-authored-by: hc-github-team-secure-vault-ecosystem <hc-github-team-secure-vault-ecosystem@users.noreply.github.com> Co-authored-by: Max Coulombe <109547106+maxcoulombe@users.noreply.github.com>
JanMa
force-pushed
the
sanitize-docs
branch
3 times, most recently
from
3fdc236
to
1de915d
Compare
joewxboy
approved these changes
Jan 22, 2024
There was a problem hiding this comment.
Two items to address in a separate (future) GitHub issue:
-
Style guide to address whether "server", "token", "agent", "proxy" should be capitalized when used as a proper name, such as "OpenBao Agent". The documentation is currently inconsistent in usage.
-
Ensure all GitHub repo path references are correct.
Signed-off-by: Jan Martens <jan@martens.eu.org>
Signed-off-by: Jan Martens <jan@martens.eu.org>
naphelps
approved these changes
Jan 22, 2024
cipherboy
approved these changes
Jan 22, 2024
| @@ -34,7 +34,7 @@ | |||
| }, | |||
|
|
|||
| { | |||
| "title": "Installing Vault", | |||
| "title": "Installing Openbao", | |||
There was a problem hiding this comment.
Not to nitpick, but we might want to make these consistent in the future.
| well. | ||
|
|
||
| Vault upgrades are designed such that large jumps (ie 1.3.10 -> 1.7.x) are | ||
| OpenBao upgrades are designed such that large jumps (ie 1.3.10 -> 1.7.x) are |
There was a problem hiding this comment.
We may want to revisit this in the future as a community, to see if we wish to keep this upgrade mechanism or not.
| The Google Cloud KMS secrets engine for Vault interfaces with Google Cloud | ||
| KMS for encryption/decryption of data and KMS key management through Vault. | ||
| The Google Cloud KMS secrets engine for OpenBao interfaces with Google Cloud | ||
| KMS for encryption/decryption of data and KMS key management through OpenBao. | ||
| --- | ||
|
|
There was a problem hiding this comment.
@JanMa This one is also an Enterprise secret engine iirc.
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 replaces
vaultwithopenbaoin the documentation where I think it makes sense. As with the API docs, I left references to older Vault versions and the Enterprise offering in tact. I also did not change any API responses orX-VaultHTTP headers.Sorry in advance for the huge PR :-)