-
Notifications
You must be signed in to change notification settings - Fork 14
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
Documentation for redis tls support. #33
Documentation for redis tls support. #33
Conversation
Typo on protobuf
Signed-off-by: Martin René Sørensen <git@sicet7.com>
WalkthroughThe changes introduce a new optional section for TLS configuration in the Redis driver configuration within the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
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.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
kv/redis.md (3)
98-110
: Add a clarifying comment for the TLS sectionConsider adding a brief comment before the TLS section to indicate its purpose:
# Optional section. + # TLS/SSL encryption configuration tls:
193-207
: Enhance TLS documentation with security best practices and referenceThe TLS configuration documentation is well-written. Consider adding:
- A security best practice note about protecting certificate files and private keys
- A reference to the Redis TLS documentation for further reading
Add the following content:
require client certificate verification, you only need to provide the `root_ca` option. +{% hint style="warning" %} +Ensure that certificate and key files have appropriate permissions and are stored securely. The Redis server process must have read access to these files. +{% endhint %} + +{% hint style="info" %} +For more information about Redis TLS support, refer to the [Redis Security documentation](https://redis.io/topics/security/). +{% endhint %}🧰 Tools
🪛 LanguageTool
[uncategorized] ~198-~198: Loose punctuation mark.
Context: ...ection will default to non-TLS.cert
: Path to a file containing the client ce...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~201-~201: Loose punctuation mark.
Context: ...en communicating with the server.key
: Path to a file containing the client pr...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~201-~201: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...he client private key. This key is used in conjunction with the client certificate for mutual auth...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[uncategorized] ~204-~204: Loose punctuation mark.
Context: ...te for mutual authentication.root_ca
: Path to a file containing the Certifica...(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
195-195: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
196-196: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
198-198: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
201-201: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
205-205: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
195-205
: Remove trailing spacesThere are trailing spaces on several lines in the new TLS documentation section. While these don't affect the rendered output, they should be removed for consistency.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~198-~198: Loose punctuation mark.
Context: ...ection will default to non-TLS.cert
: Path to a file containing the client ce...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~201-~201: Loose punctuation mark.
Context: ...en communicating with the server.key
: Path to a file containing the client pr...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~201-~201: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...he client private key. This key is used in conjunction with the client certificate for mutual auth...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[uncategorized] ~204-~204: Loose punctuation mark.
Context: ...te for mutual authentication.root_ca
: Path to a file containing the Certifica...(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
195-195: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
196-196: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
198-198: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
201-201: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
205-205: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
kv/redis.md
(2 hunks)
🧰 Additional context used
🪛 LanguageTool
kv/redis.md
[uncategorized] ~198-~198: Loose punctuation mark.
Context: ...ection will default to non-TLS. cert
: Path to a file containing the client ce...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~201-~201: Loose punctuation mark.
Context: ...en communicating with the server. key
: Path to a file containing the client pr...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~201-~201: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...he client private key. This key is used in conjunction with the client certificate for mutual auth...
(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[uncategorized] ~204-~204: Loose punctuation mark.
Context: ...te for mutual authentication. root_ca
: Path to a file containing the Certifica...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
kv/redis.md
195-195: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
196-196: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
198-198: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
201-201: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
205-205: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
Thank you, @sicet7 👍 |
This PR adds documentation for the feature implemented in this PR
Summary by CodeRabbit
New Features
cert
,key
, androot_ca
.Documentation