Skip to content

initialization from script#996

Draft
Bonusree wants to merge 11 commits into
masterfrom
fix
Draft

initialization from script#996
Bonusree wants to merge 11 commits into
masterfrom
fix

Conversation

@Bonusree

@Bonusree Bonusree commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Added new example manifests for initializing PerconaXtraDB and PgBouncer.
    • Updated initialization guides for ClickHouse, PerconaXtraDB, PgBouncer, and ProxySQL with clearer setup, verification, and credential guidance.
    • Refreshed ProxySQL examples and outputs for both secret-based and inline initialization flows.
  • Chores
    • Removed outdated Ignite version update documentation pages.

Bonusree added 5 commits July 1, 2026 17:10
Signed-off-by: Bonusree <bonusree@appscode.com>
Signed-off-by: Bonusree <bonusree@appscode.com>
Signed-off-by: Bonusree <bonusree@appscode.com>
Signed-off-by: Bonusree <bonusree@appscode.com>
Signed-off-by: Bonusree <bonusree@appscode.com>
@Bonusree Bonusree changed the title initialization initialization from script Jul 7, 2026
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Review Change Stack

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 3332b1cf-8684-4958-bb63-5929670fa701

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR adds example manifests for PerconaXtraDB and PgBouncer, updates initialization documentation for ClickHouse, PerconaXtraDB, PgBouncer, and ProxySQL with revised URLs, notes, and verification output, and removes the Ignite update-version documentation entirely.

Changes

Initialization guides and examples

Layer / File(s) Summary
PerconaXtraDB example and init guide
docs/examples/perconaxtradb/script-pxc.yaml, docs/guides/percona-xtradb/initialization/script_source.md
Adds a new PerconaXtraDB manifest and updates the guide with a credentials note, a new manifest URL, updated service naming, and a new SQL verification step.
PgBouncer example and init guide
docs/examples/pgbouncer/initialization/init_script.yaml, docs/guides/pgbouncer/initialization/script_source.md
Adds a new PgBouncer manifest and expands the initialization note with credential and verification guidance.
ClickHouse init guide updates
docs/guides/clickhouse/initialization/script_source.md
Updates the configmap source URL and simplifies the service hostname shown in verification.
ProxySQL init guide overhaul
docs/guides/proxysql/initialization/script_source.md
Revises Secret-based and inline configuration sections with new explanations, deployment steps, checklists, and refreshed verification output.
Ignite update-version docs removal
docs/guides/ignite/update-version/_index.md, docs/guides/ignite/update-version/overview.md, docs/guides/ignite/update-version/update-version.md
Removes the entire Ignite version update documentation set.

Estimated code review effort: 2 (Simple) | ~12 minutes

Possibly related PRs

  • kubedb/docs#949: Overlaps with Script Source initialization docs for ClickHouse and PerconaXtraDB guides updated in this PR.
  • kubedb/docs#985: Overlaps directly with the PerconaXtraDB init guide and script-pxc example manifest changes in this PR.

Suggested reviewers: souravbiswassanto, kodiak-appscode

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is related to the changes, but it is too vague and doesn't identify the affected docs or components. Use a more specific title such as 'Add initialization script examples and docs for PXC, PgBouncer, and ProxySQL'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@Bonusree Bonusree marked this pull request as draft July 7, 2026 05:48
Signed-off-by: Bonusree Datta <57539731+Bonusree@users.noreply.github.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 win

Fix the PgBouncer init script URL

docs/guides/pgbouncer/initialization/script_source.md still points to docs/examples/pgbouncer/initialization/script-pgbouncer.yaml, but the example file in this tree is docs/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

📥 Commits

Reviewing files that changed from the base of the PR and between 77939ec and 2993f55.

📒 Files selected for processing (9)
  • docs/examples/perconaxtradb/script-pxc.yaml
  • docs/examples/pgbouncer/initialization/init_script.yaml
  • docs/guides/clickhouse/initialization/script_source.md
  • docs/guides/ignite/update-version/_index.md
  • docs/guides/ignite/update-version/overview.md
  • docs/guides/ignite/update-version/update-version.md
  • docs/guides/percona-xtradb/initialization/script_source.md
  • docs/guides/pgbouncer/initialization/script_source.md
  • docs/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

Comment thread docs/guides/percona-xtradb/initialization/script_source.md
Comment thread docs/guides/proxysql/initialization/script_source.md Outdated
Comment thread docs/guides/proxysql/initialization/script_source.md Outdated
Comment thread docs/guides/proxysql/initialization/script_source.md Outdated
Comment thread docs/guides/pgbouncer/initialization/script_source.md
Comment thread docs/guides/clickhouse/initialization/script_source.md
Comment thread docs/guides/proxysql/initialization/script_source.md Outdated
Comment thread docs/guides/proxysql/initialization/script_source.md Outdated
Signed-off-by: Bonusree <bonusree@appscode.com>
Comment thread docs/guides/proxysql/initialization/script_source.md Outdated
Comment thread docs/guides/proxysql/initialization/script_source.md Outdated
@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown

Visit the preview URL for this PR (updated for commit c912484):

https://kubedb-v2-hugo--pr996-fix-02m0545o.web.app

(expires Wed, 15 Jul 2026 10:14:13 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 0f29ae8ae0bd54a99bf2b223b6833be47acd5943

Bonusree added 3 commits July 8, 2026 15:27
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

gitguardian Bot commented Jul 14, 2026

Copy link
Copy Markdown

⚠️ GitGuardian has uncovered 3 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
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
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secrets safely. Learn here the best practices.
  3. Revoke and rotate these secrets.
  4. 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


🦉 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.

- username: superman
active: 1
default_hostgroup: 3
# mysqlUsers:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why comment out? remove if not needed

Signed-off-by: Bonusree <bonusree@appscode.com>

@ShuvoKumarMondal ShuvoKumarMondal left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for ClickHouse.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants