add overrides upstream sync to OS upgrade documentation

[g0rgamesh]

No description provided.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

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: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2eb8db03-d041-467a-8efb-fc46afdd752c

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

Adds upgrade documentation for operators who use custom service map overrides. It instructs them to synchronise customised overcloud-services.j2 and overcloud-components.j2 files with Kayobe upstream and provides sdiff commands for comparison.

Walkthrough

The overcloud upgrade documentation now warns operators with custom service map overrides to synchronise local templates with Kayobe upstream. It includes git clone and sdiff commands for the base and environments-specific templates.

Changes

Upgrade documentation

Layer / File(s)	Summary
Custom service map synchronisation doc/source/operations/upgrading-openstack.rst	Adds a warning for custom overcloud-services.j2 and overcloud-components.j2 overrides. The warning includes commands to compare local templates with the Kayobe 2025.1 versions.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: 🔵 Low · up to a8b91

The documentation adds guidance for synchronizing customized upgrade templates, but the current commands include prose that would be interpreted as shell input and assume a fixed local checkout path, so operators may receive command errors or failed comparisons. This is a bounded documentation issue and is mergeable with explicit owner awareness or follow-up.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 108fe5e2-ae52-41d8-9877-b55da8770b7d

📥 Commits

Reviewing files that changed from the base of the PR and between 5e0e39f and a8b91f6.

📒 Files selected for processing (1)

• doc/source/operations/upgrading-openstack.rst

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📜 Review details

⏰ Context from checks skipped due to timeout. (3)

• GitHub Check: stackhpc/check
• GitHub Check: Ansible 2.18 lint with Python 3.12
• GitHub Check: Ansible 2.17 lint with Python 3.10