DOC-14357: Document cbcat tool#4133
Open
simon-dew wants to merge 8 commits into
Open
Conversation
simon-dew
commented
Jun 30, 2026
Contributor
Author
There was a problem hiding this comment.
Driveby fixes, no need to review this file.
simon-dew
requested review from
ggray-cb,
rakhi-prathap,
supritha-kumar and
timofey-barmin
trondn
reviewed
Jun 30, 2026
trondn
reviewed
Jun 30, 2026
trondn
reviewed
Jun 30, 2026
rakhi-prathap
suggested changes
Jul 1, 2026
rakhi-prathap
left a comment
rakhi-prathap
left a comment
Contributor
There was a problem hiding this comment.
Looks good to me, just some minor suggestions.
|
|
||
| When encryption at rest is active, Couchbase Server encrypts sensitive data stored on disk. | ||
| This includes logs, configuration files, audit files, and other files generated by Couchbase Server and the services running in the cluster. | ||
| The `cbcat` tool enables you to decrypt and view the contents of encrypted files that were created when encryption at rest was active. |
Contributor
There was a problem hiding this comment.
Suggested change
| The `cbcat` tool enables you to decrypt and view the contents of encrypted files that were created when encryption at rest was active. | |
| The `cbcat` tool enables you to decrypt and view the contents of these encrypted files. |
I think we don’t need to repeat “when encryption at rest was active” since that’s already mentioned in the first line.
| You can only use one of these options. | ||
|
|
||
| --with-keystore <json>:: | ||
| A JSON representation of a keystore containing the keys that were used to encrypt the files you want to decrypt and view. |
Contributor
There was a problem hiding this comment.
Maybe add a link to the Schema section?
| ---- | ||
| ==== | ||
|
|
||
| == Environment Variables |
Contributor
There was a problem hiding this comment.
Can we move this section up so it comes right after Schema and before Output?
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Jira ticket: DOC-14357
Docs preview: cbcat
You will need the Docs Team credentials on Confluence.