Skip to content

docs(upgrade): scope upgrade page to v4.4.0 with plugin dependencies and Important Notes#52

Open
SuJinpei wants to merge 8 commits into
masterfrom
docs/upgrade-plugin-dependencies
Open

docs(upgrade): scope upgrade page to v4.4.0 with plugin dependencies and Important Notes#52
SuJinpei wants to merge 8 commits into
masterfrom
docs/upgrade-plugin-dependencies

Conversation

@SuJinpei

@SuJinpei SuJinpei commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

What

The page is now scoped explicitly to the v4.4.0 upgrade (retitled "Upgrade to v4.4.0", with a link to the patch-version upgrade guide for z-stream upgrades).

The operator-level Upgrade page (docs/en/upgrade.mdx) previously dove straight into the MySQL-PXC migration checklist and never stated the foundational plugin dependencies — unlike the Kafka upgrade doc, which leads with Prerequisites and a plugin/RDS-Framework requirement.

This adds a Prerequisites section before the PXC checklist:

  • Plugin Dependencies table with the required upgrade order and minimum versions:
    Order Plugin Minimum Version
    1 Data Services Essentials (a.k.a. Application Services Core) v4.4.0+
    2 Data Services RDS Framework v4.3.x
    3 Alauda Database Service for MySQL v4.4.0+
    4 Query Analytics Operator (query-analytics-operator, optional) v4.4.0+
  • Important Notes: upgrade base plugins first, Query Analytics operator version (when used), MySQL-PXC removal is irreversible, operator rollback is not supported.
  • Version/component deltas point to the OperatorHub Upgrade prompt (the Release Notes carry no compatibility matrix).

Notes

  • The base-plugin version requirements (Essentials >= v4.4.0, RDS Framework v4.3.x, Query Analytics >= v4.4.0) are product requirements; there is currently no compatibility matrix page in the docs to cite. If a matrix is added later, these can link to it.
  • Query Analytics is an optional companion (slow query logging / analysis); MySQL-MGR functions normally without it.
  • In-page-link targets use explicit \{#id} anchors (doom 1.22.x auto-slug does not reliably match).
  • Lint clean on doom 1.12.1 and 1.22.1.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the upgrade guide for v4.4.0 with a clearer title/intro, a new Prerequisites section (pre-checklist, plugin dependency minimum versions, and required upgrade order), plus warnings including MySQL-PXC removal and other important upgrade constraints.
    • Improved navigation in the upgrade guide by adding an explicit rollback anchor.
    • Revised installation guidance to mark Data Services Essentials (v4.4.0+) and Data Services RDS Framework (v4.3.0+) as required prerequisites before installing the MySQL operator, with a link to full dependency details.

…nt Notes

The operator-level Upgrade page went straight into the MySQL-PXC
migration checklist without stating the foundational plugin
dependencies, unlike the Kafka upgrade doc. Add a Prerequisites
section with a Plugin Dependencies table and Important Notes:

- Data Services Essentials (Application Services Core) v4.4.0+
- Data Services RDS Framework v4.3.x
- upgrade order: base plugins before the operator
- PXC-removal irreversibility and operator no-rollback callouts

Point readers to the OperatorHub Upgrade prompt for plugin version
deltas (the Release Notes carry no compatibility matrix).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@SuJinpei, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 53 minutes and 5 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1b336509-ac43-437d-b13b-968dbcab2eba

📥 Commits

Reviewing files that changed from the base of the PR and between f1b3f4c and dd54864.

📒 Files selected for processing (1)
  • docs/en/upgrade.mdx

Walkthrough

The installation and upgrade docs now require Essentials for v4.4.0, add v4.4.0 upgrade prerequisites with plugin version ordering, and mark the rollback considerations heading with an explicit anchor.

Changes

v4.4.0 Documentation Updates

Layer / File(s) Summary
Installation prerequisite update
docs/en/installation.mdx
Replaces the optional installation guidance with required v4.4.0 Essentials and RDS Framework prerequisites and links to the dependency list.
Upgrade prerequisites and rollback anchor
docs/en/upgrade.mdx
Renames the upgrade page to v4.4.0, adds the prerequisite checklist, plugin dependency table, important notes, and adds the rollback considerations anchor.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 Hop, hop, v4.4.0's here,
First check the prereqs, crystal clear.
Install Essentials, then proceed,
Follow the order that you need.
A rollback anchor marks the way,
So links stay tidy every day.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: scoping the upgrade docs to v4.4.0 and adding plugin dependency and Important Notes guidance.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/upgrade-plugin-dependencies

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.

Jinpei Su and others added 3 commits June 24, 2026 03:15
…dencies

The query-analytics-operator (slow query logging / query analysis,
optional companion to MySQL-MGR) must be upgraded to v4.4.0+ when in
use. Add it to the Plugin Dependencies table and Important Notes.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Retitle to "Upgrade to v4.4.0", add a scoping intro that links to the
patch-version upgrade guide, and make the Prerequisites and Plugin
Dependencies wording v4.4.0-specific.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@SuJinpei SuJinpei changed the title docs(upgrade): add Prerequisites with plugin dependencies and Important Notes docs(upgrade): scope upgrade page to v4.4.0 with plugin dependencies and Important Notes Jun 24, 2026
Jinpei Su and others added 4 commits June 24, 2026 06:28
…ptional

Reconcile the Essentials install note with the v4.4.0 plugin dependency:
it is a required foundational platform component (also called Application
Services Core), v4.4.0+, not an optional web-console-only plugin.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
… optional

The RDS Framework is the base operator framework the MySQL operator
extends; it is required (v4.3.x), not an optional web-console-only
plugin. Mirror the Essentials fix.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…RDS Framework v4.3.x

Correct the row-2 base dependency: the MySQL operator extends the
rds-operator multi-database base operator, which must be v4.3.0 or
higher (was mislabeled as RDS Framework v4.3.x). Update the dependency
table, warning, Important Notes, and the installation tip accordingly.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ange

The column header already means "or higher", so the cells now list the
bare minimum version (v4.4.0, v4.3.0) instead of "vX or higher".

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

1 participant