Custom config for proxysql,pgbouncer#888
Draft
Bonusree wants to merge 2 commits into
Draft
Conversation
Signed-off-by: Bonusree <bonusree@appscode.com>
Signed-off-by: Bonusree <bonusree@appscode.com>
📝 WalkthroughWalkthroughAdds documentation guides for PgBouncer and ProxySQL custom configuration under ChangesPgBouncer Configuration Guides
ProxySQL Configuration Guides
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (7)
docs/guides/proxysql/configuration/using-config-file/index.md (6)
81-81: 💤 Low valuePrefer "take a look at" over "have a look at" for American English.
Minor locale preference; both guides use the British English phrasing "have a look at." For consistency with American English documentation standards, use "take a look at" instead.
docs/guides/proxysql/configuration/using-config-file/index.md#L81: Change "Have a look at" to "Take a look at"docs/guides/proxysql/configuration/using-pod-template/index.md#L73: Change "Have a look at" to "Take a look at"🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/proxysql/configuration/using-config-file/index.md` at line 81, Replace the British English phrase "Have a look at" with the American English phrase "Take a look at" for consistency with documentation standards. This change needs to be made in two files: in docs/guides/proxysql/configuration/using-config-file/index.md at line 81, change "Have a look at" to "Take a look at" in the sentence about backend examples; and in docs/guides/proxysql/configuration/using-pod-template/index.md at line 73, make the same replacement to ensure consistent American English phrasing across both guides.Source: Linters/SAST tools
44-44: ⚡ Quick winUse hyphenation for compound adjectives: "3-node" instead of "3 node".
Both guides incorrectly use "3 node" instead of the hyphenated "3-node" when modifying "MySQL Group Replication cluster."
docs/guides/proxysql/configuration/using-config-file/index.md#L44: Change "3 node" to "3-node"docs/guides/proxysql/configuration/using-pod-template/index.md#L36: Change "3 node" to "3-node"🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/proxysql/configuration/using-config-file/index.md` at line 44, Apply hyphenation to compound adjectives in two documentation files. In docs/guides/proxysql/configuration/using-config-file/index.md at line 44, change "3 node" to "3-node" in the phrase describing the MySQL Group Replication cluster setup. In docs/guides/proxysql/configuration/using-pod-template/index.md at line 36, make the same change from "3 node" to "3-node" where the compound adjective modifies the cluster description. Hyphenate compound adjectives to follow standard English grammar conventions when multiple words combine to modify a noun.Source: Linters/SAST tools
13-23: ⚡ Quick winUse descriptive link text instead of generic "here" across both guide files.
Links with text like
[here]are not user-friendly and don't provide context. This pattern appears in both the config-file and pod-template guides.
docs/guides/proxysql/configuration/using-config-file/index.md#L13-L23: Replace both "here" links (line 13: "start here" → "start with the KubeDB documentation"; line 23: "steps here" → "installation steps")docs/guides/proxysql/configuration/using-pod-template/index.md#L13-L23: Apply the same fixes to the corresponding lines.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/proxysql/configuration/using-config-file/index.md` around lines 13 - 23, Replace generic "here" link text with descriptive alternatives in both ProxySQL configuration guide files. In docs/guides/proxysql/configuration/using-config-file/index.md at lines 13-23, change the link text "[here]" on line 13 from "start here" to "start with the KubeDB documentation" and change the link text "[here]" on line 23 from "steps here" to "installation steps". Apply identical changes to the corresponding lines 13-23 in docs/guides/proxysql/configuration/using-pod-template/index.md to maintain consistency and improve user experience by providing context about what each link contains.Source: Linters/SAST tools
13-13: ⚡ Quick winUse descriptive link text instead of generic "here".
Links with text like
[here]are not user-friendly and don't provide context. Replace them with descriptive text that indicates the link target.📝 Proposed fixes for descriptive link text
- > New to KubeDB? Please start [here](/docs/README.md). + > New to KubeDB? Please start [with the KubeDB documentation](/docs/README.md). - - Now, install KubeDB cli on your workstation and KubeDB operator in your cluster following the steps [here](/docs/setup/README.md). + - Now, install KubeDB cli on your workstation and KubeDB operator in your cluster following the [installation steps](/docs/setup/README.md).Also applies to: 23-23
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/proxysql/configuration/using-config-file/index.md` at line 13, Replace the generic link text "[here]" with descriptive text that clearly indicates the link target. In the line containing the text "New to KubeDB? Please start [here](/docs/README.md)." and the other occurrence at line 23, replace "[here]" with more descriptive text such as "the KubeDB documentation" or "KubeDB getting started guide" that provides context about where the link leads, making it more user-friendly and improving accessibility.
128-128: ⚡ Quick winUse consistent capitalization: "PetSet" instead of "petset".
PetSetis the correct Kubernetes API object name. Capitalize consistently throughout the guides for clarity.📝 Proposed fixes
- Now, wait a few minutes. KubeDB operator will create necessary petset, services, secret etc. If everything goes well, we will see that a pod with the name `sample-proxysql-0` has been created. + Now, wait a few minutes. KubeDB operator will create necessary PetSet, services, secret etc. If everything goes well, we will see that a pod with the name `sample-proxysql-0` has been created. - Check that the petset's pod is running + Check that the PetSet's pod is runningAlso applies to: 130-130
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/proxysql/configuration/using-config-file/index.md` at line 128, Update the documentation file to use the correct capitalization of the Kubernetes API object name. Change all instances of "petset" to "PetSet" in the guide to maintain consistency and clarity. This applies to the text on line 128 where "petset" appears in the context of objects created by the KubeDB operator, and also on line 130 where the same term appears.
128-130: ⚡ Quick winUse consistent capitalization: "PetSet" instead of "petset".
Both guides use lowercase "petset" instead of the correct Kubernetes API object name "PetSet."
docs/guides/proxysql/configuration/using-config-file/index.md#L128: Change "necessary petset" to "necessary PetSet"docs/guides/proxysql/configuration/using-config-file/index.md#L130: Change "petset's pod" to "PetSet's pod"docs/guides/proxysql/configuration/using-pod-template/index.md#L135: Change "necessary petset" to "necessary PetSet"docs/guides/proxysql/configuration/using-pod-template/index.md#L137: Change "petset's pod" to "PetSet's pod"🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/proxysql/configuration/using-config-file/index.md` around lines 128 - 130, The Kubernetes API object name "PetSet" is incorrectly capitalized as lowercase "petset" across multiple documentation files. Fix the capitalization at the following locations: In docs/guides/proxysql/configuration/using-config-file/index.md at line 128, change "necessary petset" to "necessary PetSet"; at line 130, change "petset's pod" to "PetSet's pod". In docs/guides/proxysql/configuration/using-pod-template/index.md at line 135, change "necessary petset" to "necessary PetSet"; at line 137, change "petset's pod" to "PetSet's pod". Use the correct capitalization consistently throughout to reflect the proper Kubernetes API object naming convention.Source: Linters/SAST tools
docs/guides/proxysql/configuration/using-pod-template/index.md (1)
78-78: 💤 Low valueAvoid repeating the same word at the start of successive sentences.
Lines 77-79 have three consecutive sentences starting with "KubeDB". Consider rewording for better prose flow.
📝 Proposed fix
- KubeDB allows providing a template for the ProxySQL pod through `.spec.podTemplate`. KubeDB operator will pass the information provided in `.spec.podTemplate` to the PetSet created for ProxySQL. - - KubeDB accepts the following fields to set in `.spec.podTemplate`: + KubeDB allows providing a template for the ProxySQL pod through `.spec.podTemplate`. The operator will pass this information to the PetSet created for ProxySQL. + + The following fields are supported in `.spec.podTemplate`:🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/proxysql/configuration/using-pod-template/index.md` at line 78, In the documentation file, lines 77-79 contain three consecutive sentences that all begin with "KubeDB", creating repetitive prose. Reword at least one or two of these sentences to vary the sentence structure and improve readability. Consider restructuring the sentences to use different subjects, combine related ideas, or use transitional phrases that allow some sentences to start with different words while maintaining clarity and document flow.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/guides/proxysql/configuration/using-config-file/index.md`:
- Line 81: Replace the British English phrase "Have a look at" with the American
English phrase "Take a look at" for consistency with documentation standards.
This change needs to be made in two files: in
docs/guides/proxysql/configuration/using-config-file/index.md at line 81, change
"Have a look at" to "Take a look at" in the sentence about backend examples; and
in docs/guides/proxysql/configuration/using-pod-template/index.md at line 73,
make the same replacement to ensure consistent American English phrasing across
both guides.
- Line 44: Apply hyphenation to compound adjectives in two documentation files.
In docs/guides/proxysql/configuration/using-config-file/index.md at line 44,
change "3 node" to "3-node" in the phrase describing the MySQL Group Replication
cluster setup. In docs/guides/proxysql/configuration/using-pod-template/index.md
at line 36, make the same change from "3 node" to "3-node" where the compound
adjective modifies the cluster description. Hyphenate compound adjectives to
follow standard English grammar conventions when multiple words combine to
modify a noun.
- Around line 13-23: Replace generic "here" link text with descriptive
alternatives in both ProxySQL configuration guide files. In
docs/guides/proxysql/configuration/using-config-file/index.md at lines 13-23,
change the link text "[here]" on line 13 from "start here" to "start with the
KubeDB documentation" and change the link text "[here]" on line 23 from "steps
here" to "installation steps". Apply identical changes to the corresponding
lines 13-23 in docs/guides/proxysql/configuration/using-pod-template/index.md to
maintain consistency and improve user experience by providing context about what
each link contains.
- Line 13: Replace the generic link text "[here]" with descriptive text that
clearly indicates the link target. In the line containing the text "New to
KubeDB? Please start [here](/docs/README.md)." and the other occurrence at line
23, replace "[here]" with more descriptive text such as "the KubeDB
documentation" or "KubeDB getting started guide" that provides context about
where the link leads, making it more user-friendly and improving accessibility.
- Line 128: Update the documentation file to use the correct capitalization of
the Kubernetes API object name. Change all instances of "petset" to "PetSet" in
the guide to maintain consistency and clarity. This applies to the text on line
128 where "petset" appears in the context of objects created by the KubeDB
operator, and also on line 130 where the same term appears.
- Around line 128-130: The Kubernetes API object name "PetSet" is incorrectly
capitalized as lowercase "petset" across multiple documentation files. Fix the
capitalization at the following locations: In
docs/guides/proxysql/configuration/using-config-file/index.md at line 128,
change "necessary petset" to "necessary PetSet"; at line 130, change "petset's
pod" to "PetSet's pod". In
docs/guides/proxysql/configuration/using-pod-template/index.md at line 135,
change "necessary petset" to "necessary PetSet"; at line 137, change "petset's
pod" to "PetSet's pod". Use the correct capitalization consistently throughout
to reflect the proper Kubernetes API object naming convention.
In `@docs/guides/proxysql/configuration/using-pod-template/index.md`:
- Line 78: In the documentation file, lines 77-79 contain three consecutive
sentences that all begin with "KubeDB", creating repetitive prose. Reword at
least one or two of these sentences to vary the sentence structure and improve
readability. Consider restructuring the sentences to use different subjects,
combine related ideas, or use transitional phrases that allow some sentences to
start with different words while maintaining clarity and document flow.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 4719642c-a81b-43b5-8931-9862d57b815c
📒 Files selected for processing (10)
docs/guides/pgbouncer/configuration/_index.mddocs/guides/pgbouncer/configuration/using-config-file/examples/pb-custom.yamldocs/guides/pgbouncer/configuration/using-config-file/index.mddocs/guides/pgbouncer/configuration/using-pod-template/examples/pb-misc-config.yamldocs/guides/pgbouncer/configuration/using-pod-template/index.mddocs/guides/proxysql/configuration/_index.mddocs/guides/proxysql/configuration/using-config-file/examples/proxysql-custom.yamldocs/guides/proxysql/configuration/using-config-file/index.mddocs/guides/proxysql/configuration/using-pod-template/examples/proxysql-misc-config.yamldocs/guides/proxysql/configuration/using-pod-template/index.md
|
Visit the preview URL for this PR (updated for commit 49363c8): https://kubedb-v2-hugo--pr888-custom-config-619ktira.web.app (expires Tue, 23 Jun 2026 12:49:49 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 0f29ae8ae0bd54a99bf2b223b6833be47acd5943 |
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
1 participant
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.
Summary by CodeRabbit