Conversation
Signed-off-by: Bonusree <bonusree@appscode.com>
Signed-off-by: Bonusree <bonusree@appscode.com>
Signed-off-by: Bonusree <bonusree@appscode.com>
ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
💤 Files with no reviewable changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis PR adds PerconaXtraDB and PgBouncer initialization manifests, updates ClickHouse, PerconaXtraDB, PgBouncer, and ProxySQL initialization guides, and removes the Ignite update-version documentation. ChangesInitialization guides and examples
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
⚔️ Resolve merge conflicts
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 |
Signed-off-by: Bonusree Datta <57539731+Bonusree@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/guides/pgbouncer/initialization/script_source.md (1)
94-97: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick winFix the PgBouncer init script URL
docs/guides/pgbouncer/initialization/script_source.mdstill points todocs/examples/pgbouncer/initialization/script-pgbouncer.yaml, but the example file in this tree isdocs/examples/pgbouncer/initialization/init_script.yaml. Update the link so the tutorial doesn't 404.🤖 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/pgbouncer/initialization/script_source.md` around lines 94 - 97, The PgBouncer initialization example still references the old script-pgbouncer.yaml path, which will 404. Update the kubectl create URL in the script_source guide to point to the current init_script.yaml example under the docs/examples/pgbouncer/initialization source, keeping the same versioned raw GitHub pattern so the tutorial links to the correct file.
🤖 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.
Inline comments:
In `@docs/guides/percona-xtradb/initialization/script_source.md`:
- Around line 343-356: The verification example in the kubectl exec/mysql
snippet uses a different hard-coded root password than the one shown above, so
update the command to use the same credential value as the preceding output.
Make the fix in the documentation block under the verification example so the
kubectl exec command is copy/pasteable without manual edits.
In `@docs/guides/proxysql/initialization/script_source.md`:
- Line 254: Tighten the verification statement in the initialization guide so it
only claims what the sample output actually demonstrates. In the prose around
the `proxysql-init-raw` Secret example, revise the sentence that mentions
`mysql_users`, `mysql_query_rules`, and global variables to avoid asserting
`mysql_query_rules` was verified unless the example output in that section
explicitly shows it.
- Line 370: The inline verification summary is too broad and currently claims
confirmation of mysqlQueryRules, mysqlVariables, and adminVariables even though
the visible output only shows global_variables. Update the wording in the
relevant documentation section to match what the query output actually proves,
or extend the verification steps in the same ProxySQL initialization walkthrough
so the missing mysqlQueryRules, mysqlVariables, and adminVariables checks are
explicitly shown before keeping the broader claim.
- Around line 204-210: The Secret-based example in the initialization
walkthrough is still using the inline-auth secret name and a mismatched mysql
password, so it cannot be replayed as written. Update the Secret-specific
credentials example to reference the correct Secret name for the secret-based
flow and make the mysql command use the same username/password shown immediately
above, keeping the walkthrough consistent with the secret_source section.
---
Outside diff comments:
In `@docs/guides/pgbouncer/initialization/script_source.md`:
- Around line 94-97: The PgBouncer initialization example still references the
old script-pgbouncer.yaml path, which will 404. Update the kubectl create URL in
the script_source guide to point to the current init_script.yaml example under
the docs/examples/pgbouncer/initialization source, keeping the same versioned
raw GitHub pattern so the tutorial links to the correct file.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: f8138917-1468-49d1-967c-bb484f4f527d
📒 Files selected for processing (9)
docs/examples/perconaxtradb/script-pxc.yamldocs/examples/pgbouncer/initialization/init_script.yamldocs/guides/clickhouse/initialization/script_source.mddocs/guides/ignite/update-version/_index.mddocs/guides/ignite/update-version/overview.mddocs/guides/ignite/update-version/update-version.mddocs/guides/percona-xtradb/initialization/script_source.mddocs/guides/pgbouncer/initialization/script_source.mddocs/guides/proxysql/initialization/script_source.md
💤 Files with no reviewable changes (3)
- docs/guides/ignite/update-version/update-version.md
- docs/guides/ignite/update-version/overview.md
- docs/guides/ignite/update-version/_index.md
|
Visit the preview URL for this PR (updated for commit 296c18b): https://kubedb-v2-hugo--pr996-fix-5pnhdxwt.web.app (expires Wed, 22 Jul 2026 05:45:47 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 0f29ae8ae0bd54a99bf2b223b6833be47acd5943 |
Signed-off-by: Bonusree <bonusree@appscode.com>
Signed-off-by: Bonusree <bonusree@appscode.com>
# Conflicts: # docs/guides/clickhouse/initialization/script_source.md # docs/guides/percona-xtradb/initialization/script_source.md # docs/guides/pgbouncer/initialization/script_source.md # docs/guides/postgres/initialization/script_source.md # docs/guides/proxysql/initialization/examples/proxysql-init-inline.yaml # docs/guides/proxysql/initialization/script_source.md Signed-off-by: Bonusree <bonusree@appscode.com>
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 34433002 | Triggered | Generic CLI Secret | ec54da8 | docs/guides/percona-xtradb/initialization/script_source.md | View secret |
| 34433003 | Triggered | Generic CLI Secret | ec54da8 | docs/guides/clickhouse/initialization/script_source.md | View secret |
| 34433003 | Triggered | Generic CLI Secret | ec54da8 | docs/guides/clickhouse/initialization/script_source.md | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secrets safely. Learn here the best practices.
- Revoke and rotate these secrets.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
Signed-off-by: Bonusree <bonusree@appscode.com>
ShuvoKumarMondal
left a comment
There was a problem hiding this comment.
LGTM for ClickHouse.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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.
Inline comments:
In `@docs/guides/pgbouncer/initialization/script_source.md`:
- Line 55: Update the initialization script note to instruct users to obtain
PostgreSQL authentication credentials from a Secret-backed source, such as
quick-postgres-auth, rather than embedding passwords in the ConfigMap-backed
init.sh script. Preserve the guidance that custom scripts may perform
environment-specific setup.
In `@docs/guides/proxysql/initialization/script_source.md`:
- Around line 447-449: Update the ProxySQL administration command in the
initialization guide to use the previously generated $ADMIN_USER and $ADMIN_PASS
variables from the host shell instead of hard-coded admin/admin credentials.
Invoke the MySQL client directly through kubectl with those variables while
preserving the existing namespace, pod, host, port, and prompt settings.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 3d6a7ff3-f19c-425e-9c58-68b31ba24100
📒 Files selected for processing (5)
docs/guides/percona-xtradb/initialization/script_source.mddocs/guides/pgbouncer/initialization/script_source.mddocs/guides/proxysql/initialization/examples/proxyops-add-users.yamldocs/guides/proxysql/initialization/examples/proxysql-init-inline.yamldocs/guides/proxysql/initialization/script_source.md
💤 Files with no reviewable changes (1)
- docs/guides/proxysql/initialization/examples/proxysql-init-inline.yaml
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/guides/percona-xtradb/initialization/script_source.md
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's internal server error or limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
Actionable comments posted: 2
🤖 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.
Inline comments:
In `@docs/guides/pgbouncer/initialization/script_source.md`:
- Line 55: Update the initialization script note to instruct users to obtain
PostgreSQL authentication credentials from a Secret-backed source, such as
quick-postgres-auth, rather than embedding passwords in the ConfigMap-backed
init.sh script. Preserve the guidance that custom scripts may perform
environment-specific setup.
In `@docs/guides/proxysql/initialization/script_source.md`:
- Around line 447-449: Update the ProxySQL administration command in the
initialization guide to use the previously generated $ADMIN_USER and $ADMIN_PASS
variables from the host shell instead of hard-coded admin/admin credentials.
Invoke the MySQL client directly through kubectl with those variables while
preserving the existing namespace, pod, host, port, and prompt settings.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 3d6a7ff3-f19c-425e-9c58-68b31ba24100
📒 Files selected for processing (5)
docs/guides/percona-xtradb/initialization/script_source.mddocs/guides/pgbouncer/initialization/script_source.mddocs/guides/proxysql/initialization/examples/proxyops-add-users.yamldocs/guides/proxysql/initialization/examples/proxysql-init-inline.yamldocs/guides/proxysql/initialization/script_source.md
💤 Files with no reviewable changes (1)
- docs/guides/proxysql/initialization/examples/proxysql-init-inline.yaml
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/guides/percona-xtradb/initialization/script_source.md
🛑 Comments failed to post (2)
docs/guides/pgbouncer/initialization/script_source.md (1)
55-55: 🔒 Security & Privacy | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash rg -n -C3 'init:|secret|Secret|configMap' docs/examples/pgbouncer docs/guides/pgbouncerRepository: kubedb/docs
Length of output: 50370
🏁 Script executed:
#!/bin/bash set -euo pipefail echo '--- docs/guides/pgbouncer/initialization/script_source.md (around lines 45-60) ---' sed -n '45,60p' docs/guides/pgbouncer/initialization/script_source.md echo echo '--- docs/guides/pgbouncer/initialization/script_source.md (around lines 160-175) ---' sed -n '160,175p' docs/guides/pgbouncer/initialization/script_source.md echo echo '--- secret / credential references in PgBouncer initialization docs ---' rg -n -C2 'secret|Secret|credential|password' docs/guides/pgbouncer/initialization/*.md docs/examples/pgbouncer/initialization/*.yamlRepository: kubedb/docs
Length of output: 8919
Avoid putting PostgreSQL credentials in the ConfigMap-backed init script.
Point users to a Secret-backed source for auth instead of suggesting they include passwords ininit.sh; the later example already shows the password coming fromquick-postgres-auth.🤖 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/pgbouncer/initialization/script_source.md` at line 55, Update the initialization script note to instruct users to obtain PostgreSQL authentication credentials from a Secret-backed source, such as quick-postgres-auth, rather than embedding passwords in the ConfigMap-backed init.sh script. Preserve the guidance that custom scripts may perform environment-specific setup.docs/guides/proxysql/initialization/script_source.md (1)
447-449: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Use the generated ProxySQL credentials instead of
admin/admin.The earlier steps retrieve credentials from
proxy-init-inline-auth, but this command uses a different hard-coded pair and will not replay the documented setup reliably. Execute the MySQL client directly with$ADMIN_USERand$ADMIN_PASSfrom the host shell.Proposed fix
- kubectl exec -it -n demo proxy-init-inline-0 -- bash - proxysql@proxy-init-inline-0:/$ mysql -uadmin -padmin -h127.0.0.1 -P6032 --prompt "ProxySQLAdmin > " +$ kubectl exec -it -n demo proxy-init-inline-0 -- mysql \ + -u"$ADMIN_USER" -p"$ADMIN_PASS" -h 127.0.0.1 -P 6032 \ + --prompt "ProxySQLAdmin > "📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.$ kubectl exec -it -n demo proxy-init-inline-0 -- mysql \ -u"$ADMIN_USER" -p"$ADMIN_PASS" -h 127.0.0.1 -P 6032 \ --prompt "ProxySQLAdmin > "🤖 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/initialization/script_source.md` around lines 447 - 449, Update the ProxySQL administration command in the initialization guide to use the previously generated $ADMIN_USER and $ADMIN_PASS variables from the host shell instead of hard-coded admin/admin credentials. Invoke the MySQL client directly through kubectl with those variables while preserving the existing namespace, pod, host, port, and prompt settings.
Signed-off-by: souravbiswassanto <saurov@appscode.com>
This reverts commit 22f3dcb.
Signed-off-by: Bonusree <bonusree@appscode.com>
Summary by CodeRabbit