MTA-6896 upgrade guide#389
Conversation
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@redhat.com>
|
Warning Review limit reached
Next review available in: 57 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the 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 reviews. How do review 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 refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds MTA 8.2 upgrade documentation, updates installation and persistent-volume guidance, refreshes product metadata, introduces an upgrade-guide structure, and corrects an existing migration-path heading. ChangesMTA 8.2 documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@redhat.com>
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 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/topics/mta-upgrade/con_intro-mta-upgrade.adoc`:
- Line 27: Update the MTA Operator update checker link’s query string to use a
single ampersand before the upgrade_path parameter, preserving the existing
operator and upgrade path values.
In `@docs/topics/mta-upgrade/con_keycloak_migration.adoc`:
- Around line 13-17: Clarify the storage statement in the MTA upgrade
documentation to specify that the 1 GiB Keycloak database volume is no longer
required only for Keycloak resources managed by MTA. Preserve the surrounding
guidance for separately configured external Keycloak instances, which may still
require their own database storage.
In `@docs/topics/mta-upgrade/proc_upgrade_mta.adoc`:
- Line 39: Update the “Persistent volume requirements” link in the MTA upgrade
guide to reference the corresponding 8.2 installation documentation instead of
the 8.1 URL, preserving the existing link text and anchor topic.
In `@docs/topics/templates/document-attributes.adoc`:
- Line 30: Update the documentation attributes alongside ProductVersion so
ProductDistributionVersion and ProductDistribution reference the 8.2.0
distribution and artifacts instead of 8.1.2, keeping install and path examples
consistent with the 8.2 guide.
In `@docs/upgrade-guide/master-docinfo.xml`:
- Around line 1-6: Update the metadata in master-docinfo.xml to identify the
document as the upgrade guide rather than an MTA rules guide, matching the
upgrade-guide metadata defined by master.adoc. Revise the abstract’s topic list
to use parallel wording for administrators, while preserving the existing
product placeholders.
In `@docs/upgrade-guide/master.adoc`:
- Line 14: Update the include directive in the upgrade guide master document to
reference the inclusive-language topic under the mta-upgrade directory,
preserving the existing topic filename and ensuring the upgrade-guide build
resolves it correctly.
🪄 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
Run ID: 52436213-ea4a-4abc-b90f-4a8171f5b3a4
📒 Files selected for processing (14)
docs/topics/mta-cli/ref_supported-migration-paths.adocdocs/topics/mta-install/con_mta-tools.adocdocs/topics/mta-install/proc_installing-mta-operator.adocdocs/topics/mta-install/ref_persistent-volume-requirements.adocdocs/topics/mta-upgrade/con_cli-command-updates.adocdocs/topics/mta-upgrade/con_intro-mta-upgrade.adocdocs/topics/mta-upgrade/con_keycloak_migration.adocdocs/topics/mta-upgrade/making-open-source-more-inclusive.adocdocs/topics/mta-upgrade/proc_upgrade_mta.adocdocs/topics/templates/document-attributes.adocdocs/upgrade-guide/assembliesdocs/upgrade-guide/master-docinfo.xmldocs/upgrade-guide/master.adocdocs/upgrade-guide/topics
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@redhat.com>
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@redhat.com>
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@redhat.com>
| :_template-generated: 2025-09-12 | ||
| :_mod-docs-content-type: CONCEPT | ||
|
|
||
| [id="cli-command-updates_{context}"] |
There was a problem hiding this comment.
Hi @eemcmullan
I needed to document major changes that could impact customer's deployment after an MTA upgrade. Please could you take a look at the CLI section and confirm if I need to mention anything else? Thanks in advance!
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@redhat.com>
igallagh-redhat
left a comment
There was a problem hiding this comment.
Hi just needs the asciidoc changed to a numbered list for the procedure and verification procedure in docs/topics/mta-upgrade/proc_upgrade_mta.adoc. Otherwise LGTM!
|
|
||
| .Procedure | ||
|
|
||
| * On the Red Hat {ocp-name} cluster, go to *Ecosystem > Installed Operators*. |
There was a problem hiding this comment.
Should all the * at the start of each step be . instead, to create numbered steps?
There was a problem hiding this comment.
@igallagh-redhat Thank you! I corrected the formatting. Please could you approve the PR if the updates look ok to you?
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@redhat.com>
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@redhat.com>
| @@ -0,0 +1,12 @@ | |||
| <title>Configuring and using rules for an MTA analysis</title> | |||
There was a problem hiding this comment.
Wrong title I think .
"Upgrading the migration toolkit for applications"
There was a problem hiding this comment.
Will correct it, thanks!
JIRA
Version
Preview
Summary by CodeRabbit