Conversation
Signed-off-by: Rabbani Islam Refat <refat@appscode.com>
|
Visit the preview URL for this PR (updated for commit 9d9c3e8): https://kubedb-v2-hugo--pr887-migration-f4rbd9l5.web.app (expires Thu, 25 Jun 2026 13:35:42 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 0f29ae8ae0bd54a99bf2b223b6833be47acd5943 |
Signed-off-by: Rabbani Islam Refat <refat@appscode.com>
|
|
||
| - The source `PostgreSQL` instance must be network-reachable from within your Kubernetes cluster. | ||
|
|
||
| - The source `PostgreSQL` instance must have `wal_level` set to `logical`. The database user provided for migration must have the `REPLICATION` privilege. |
There was a problem hiding this comment.
All DBs has this kind of pre-requisites. Can you add some source-links or tell where/how to do this ?
| First, create an authentication secret to communicate with the source MariaDB database: | ||
|
|
||
| ```bash | ||
| $ kubectl create secret generic source-mariadb-auth -n demo \ |
| Every 2.0s: kubectl get migrator -n demo | ||
|
|
||
| NAME PHASE DBTYPE STAGE LAG PROGRESS AGE | ||
| mysql-migrate Running mysql Streaming 0B 4h36m |
There was a problem hiding this comment.
What is the way I can see the migration progress percentage ? I see empty value here.
Signed-off-by: Pulok Saha <puloksaha@appscode.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughNew documentation pages are added for the KubeDB Migrator feature. An operator manual README describes the migration process, helm setup, and a 7-step procedure. Per-database guides (MariaDB, MongoDB, MySQL, PostgreSQL) each cover prerequisites, Kubernetes resource creation, Migrator CR configuration, LAG monitoring, and cutover steps. ChangesKubeDB Migrator Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/operatormanual/migration/README.md (1)
59-64:⚠️ Potential issue | 🟠 Major | ⚡ Quick winMongoDB migration support is missing from the supported database list.
The PR adds a complete MongoDB migration guide (
docs/guides/mongodb/migration/databaseMigration.md), but it is not listed in the "Supported Database" section. Add the MongoDB link to maintain consistency with the provided documentation.📝 Proposed fix to add MongoDB to supported databases
[PostgreSQL](/docs/guides/postgres/migration/databaseMigration.md) [MySQL](/docs/guides/mysql/migration/databaseMigration.md) [MariaDB](/docs/guides/mariadb/migration/databaseMigration.md) + +[MongoDB](/docs/guides/mongodb/migration/databaseMigration.md)🤖 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/operatormanual/migration/README.md` around lines 59 - 64, MongoDB migration support is missing from the supported database list in the README file even though the MongoDB migration guide has been added. Add a new line with the MongoDB migration link in the same format as the existing PostgreSQL, MySQL, and MariaDB entries in the supported database section at the specified location, ensuring consistency with the other database migration documentation links.
🧹 Nitpick comments (5)
docs/guides/mariadb/migration/databaseMigration.md (1)
13-13: 💤 Low valueUse descriptive link text instead of "here".
Lines 13 and 23 use the anchor text "here", which is not descriptive. Consider: "Please start [here]" → "Please [start with KubeDB basics]" and "following the steps [here]" → "in the [KubeDB migration setup guide]".
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/mariadb/migration/databaseMigration.md` at line 13, The anchor text "here" used in links at lines 13 and 23 is not descriptive and should be replaced with more meaningful text. On line 13, change the link text from "[here]" to something descriptive like "[start with KubeDB basics]" to indicate what the link leads to. On line 23, similarly replace "[here]" with a descriptive alternative like "[KubeDB migration setup guide]" that better describes the linked content. This makes the links more accessible and helps readers understand where they will navigate to.docs/guides/mongodb/migration/databaseMigration.md (1)
13-13: 💤 Low valueUse descriptive link text instead of "here".
Lines 13 and 23 use the anchor text "here", which is not descriptive. Consider: "Please start [here]" → "Please [start with KubeDB basics]" and "following the steps [here]" → "in the [KubeDB migration setup guide]".
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/mongodb/migration/databaseMigration.md` at line 13, Replace non-descriptive link text "here" with meaningful, descriptive anchor text that explains what the user will find when clicking the link. In the databaseMigration.md file, change the anchor text on line 13 from "here" to something descriptive like "start with KubeDB basics" that indicates the link leads to KubeDB documentation basics, and similarly update the anchor text on line 23 from "here" to a descriptive alternative like "KubeDB migration setup guide" that clearly indicates the link's destination and purpose. Ensure the new link text is concise and provides context about what the reader will encounter.docs/operatormanual/migration/README.md (1)
16-16: 💤 Low valueUse descriptive link text instead of "here".
Line 16 has a link with the anchor text "here", which does not describe what the link points to. Consider: "Please start here" → "Please start with KubeDB basics" or similar.
🤖 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/operatormanual/migration/README.md` at line 16, The link text "here" in the blockquote on line 16 is not descriptive and does not convey the destination or purpose to users. Replace the anchor text "here" with a more descriptive phrase such as "KubeDB basics" or "get started with KubeDB" while keeping the URL path /docs/README.md unchanged. This improves accessibility and user experience by making the link destination clear before clicking.docs/guides/postgres/migration/databaseMigration.md (1)
13-13: 💤 Low valueUse descriptive link text instead of "here".
Lines 13 and 31 use the anchor text "here", which is not descriptive. Consider: "Please start [here]" → "Please [start with KubeDB basics]" and "Install
KubeDBoperator with the Migrator operator enabled in your cluster following the steps [here]" → "following the steps in the [KubeDB migration setup guide]".Also applies to: 31-31
🤖 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/postgres/migration/databaseMigration.md` at line 13, The link anchor text "here" on lines 13 and 31 is not descriptive and should be replaced with meaningful text that describes the destination. On line 13, change the anchor text from "here" in the phrase about starting with KubeDB to descriptive text like "start with KubeDB basics". On line 31, change the anchor text from "here" in the phrase about migration steps to descriptive text like "KubeDB migration setup guide" to make the link purpose clear to readers.docs/guides/mysql/migration/databaseMigration.md (1)
13-13: 💤 Low valueUse descriptive link text instead of "here".
Lines 13 and 23 use the anchor text "here", which is not descriptive. Consider: "Please start [here]" → "Please [start with KubeDB basics]" and "following the steps [here]" → "in the [KubeDB migration setup guide]".
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/mysql/migration/databaseMigration.md` at line 13, The link anchor text "here" on lines 13 and 23 is not descriptive and does not convey what the user will find when clicking the link. Replace the generic "here" text with descriptive alternatives that explain the link's purpose: on line 13 change "start [here]" to "start with [KubeDB basics]" to describe the README content, and on line 23 change "following the steps [here]" to a descriptive phrase like "[KubeDB migration setup guide]" that clearly indicates what the reader will find. This improves accessibility and helps users understand where they are being directed before clicking.
🤖 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/mysql/migration/databaseMigration.md`:
- Around line 99-101: The kubectl command at line 99 references a remote
quickstart-v1.yaml template from GitHub instead of using the target-mysql.yaml
file that was created earlier in the guide (lines 80-96). Replace the entire
command to use kubectl apply with the locally created target-mysql.yaml file
instead of kubectl create with the remote quickstart URL. This will ensure users
deploy the configured database defined in the migration workflow steps, not a
generic quickstart template, and will align with the PostgreSQL and MariaDB
guide examples.
---
Outside diff comments:
In `@docs/operatormanual/migration/README.md`:
- Around line 59-64: MongoDB migration support is missing from the supported
database list in the README file even though the MongoDB migration guide has
been added. Add a new line with the MongoDB migration link in the same format as
the existing PostgreSQL, MySQL, and MariaDB entries in the supported database
section at the specified location, ensuring consistency with the other database
migration documentation links.
---
Nitpick comments:
In `@docs/guides/mariadb/migration/databaseMigration.md`:
- Line 13: The anchor text "here" used in links at lines 13 and 23 is not
descriptive and should be replaced with more meaningful text. On line 13, change
the link text from "[here]" to something descriptive like "[start with KubeDB
basics]" to indicate what the link leads to. On line 23, similarly replace
"[here]" with a descriptive alternative like "[KubeDB migration setup guide]"
that better describes the linked content. This makes the links more accessible
and helps readers understand where they will navigate to.
In `@docs/guides/mongodb/migration/databaseMigration.md`:
- Line 13: Replace non-descriptive link text "here" with meaningful, descriptive
anchor text that explains what the user will find when clicking the link. In the
databaseMigration.md file, change the anchor text on line 13 from "here" to
something descriptive like "start with KubeDB basics" that indicates the link
leads to KubeDB documentation basics, and similarly update the anchor text on
line 23 from "here" to a descriptive alternative like "KubeDB migration setup
guide" that clearly indicates the link's destination and purpose. Ensure the new
link text is concise and provides context about what the reader will encounter.
In `@docs/guides/mysql/migration/databaseMigration.md`:
- Line 13: The link anchor text "here" on lines 13 and 23 is not descriptive and
does not convey what the user will find when clicking the link. Replace the
generic "here" text with descriptive alternatives that explain the link's
purpose: on line 13 change "start [here]" to "start with [KubeDB basics]" to
describe the README content, and on line 23 change "following the steps [here]"
to a descriptive phrase like "[KubeDB migration setup guide]" that clearly
indicates what the reader will find. This improves accessibility and helps users
understand where they are being directed before clicking.
In `@docs/guides/postgres/migration/databaseMigration.md`:
- Line 13: The link anchor text "here" on lines 13 and 31 is not descriptive and
should be replaced with meaningful text that describes the destination. On line
13, change the anchor text from "here" in the phrase about starting with KubeDB
to descriptive text like "start with KubeDB basics". On line 31, change the
anchor text from "here" in the phrase about migration steps to descriptive text
like "KubeDB migration setup guide" to make the link purpose clear to readers.
In `@docs/operatormanual/migration/README.md`:
- Line 16: The link text "here" in the blockquote on line 16 is not descriptive
and does not convey the destination or purpose to users. Replace the anchor text
"here" with a more descriptive phrase such as "KubeDB basics" or "get started
with KubeDB" while keeping the URL path /docs/README.md unchanged. This improves
accessibility and user experience by making the link destination clear before
clicking.
🪄 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: ad86f9e0-225e-4855-bc67-36d7ef935df7
📒 Files selected for processing (7)
docs/guides/mariadb/migration/_index.mddocs/guides/mariadb/migration/databaseMigration.mddocs/guides/mongodb/migration/_index.mddocs/guides/mongodb/migration/databaseMigration.mddocs/guides/mysql/migration/databaseMigration.mddocs/guides/postgres/migration/databaseMigration.mddocs/operatormanual/migration/README.md
| $ kubectl create -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/guides/mysql/quickstart/yamls/quickstart-v1.yaml | ||
| mysql.kubedb.com/mysql-quickstart created | ||
| ``` |
There was a problem hiding this comment.
Critical: kubectl command does not match the target-mysql.yaml created above.
Line 99 creates a database from a remote quickstart template (quickstart-v1.yaml) instead of the target-mysql.yaml defined in lines 80-96. This breaks the workflow—users will create a different database than intended.
Compare to the PostgreSQL guide (line 107) and MariaDB guide (line 100), which correctly use kubectl apply -f target-mysql.yaml.
🐛 Proposed fix
$ kubectl create -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/guides/mysql/quickstart/yamls/quickstart-v1.yaml
-mysql.kubedb.com/mysql-quickstart created
+$ kubectl apply -f target-mysql.yaml
+mysql.kubedb.com/target-mysql created🤖 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/mysql/migration/databaseMigration.md` around lines 99 - 101, The
kubectl command at line 99 references a remote quickstart-v1.yaml template from
GitHub instead of using the target-mysql.yaml file that was created earlier in
the guide (lines 80-96). Replace the entire command to use kubectl apply with
the locally created target-mysql.yaml file instead of kubectl create with the
remote quickstart URL. This will ensure users deploy the configured database
defined in the migration workflow steps, not a generic quickstart template, and
will align with the PostgreSQL and MariaDB guide examples.
Signed-off-by: Rabbani Islam Refat <refat@appscode.com>
3 participants
Summary by CodeRabbit