add override section to upgrade doc

[g0rgamesh]

No description provided.

[coderabbitai]

📝 Summary

Adds an upgrade guide warning for custom service map overrides. It instructs users to synchronise overcloud-services.j2 and overcloud-components.j2 with Kayobe upstream and provides sdiff commands for base and environment-specific templates.

Walkthrough

The upgrade guide now warns users with custom service map overrides to synchronise them with Kayobe upstream. It provides git clone and sdiff commands for base and environment-specific kayobe-config paths.

Changes

Upgrade guidance

Layer / File(s)	Summary
Custom service map synchronisation doc/source/operations/upgrading-openstack.rst	Adds warning text and sdiff examples for comparing customised overcloud-services.j2 and overcloud-components.j2 files with Kayobe upstream templates.

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

Merge Risk: 🟡 Moderate · up to d4267

The upgrade guide can direct operators to compare the wrong release or an unavailable local path, allowing service-map changes to be missed during upgrades. Update the commands before merging.

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

---

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: 1

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: bd06c1d5-c0b3-4e92-9bb4-1aa965d57629

📥 Commits

Reviewing files that changed from the base of the PR and between 6a4d547 and d426743.

📒 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. (4)

• GitHub Check: stackhpc/check
• GitHub Check: Ansible 2.19 lint with Python 3.12
• GitHub Check: Ansible 2.20 lint with Python 3.12
• GitHub Check: Tox docs with Python 3.12

[coderabbitai]

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Use the target release and the active configuration path.

This guide targets the 2026.1 upgrade, but the commands clone stackhpc/2025.1 and compare against /home/stack/2025.1-upgrade/.... The 2025.1 and 2026.1 upstream templates already differ, so this comparison can miss mappings required by the target release. (raw.githubusercontent.com)

The absolute path also fails when the deployment uses another checkout location. Use the release substitution used elsewhere in this guide, enable :substitutions: for this code block, and use $KAYOBE_CONFIG_PATH and $KAYOBE_ENVIRONMENT for the local files. This keeps the comparison aligned with the overcloud-services.j2 input loaded by kolla.yml.

Suggested update

 .. code-block:: console
+   :substitutions:

-      git clone https://github.com/stackhpc/kayobe -b stackhpc/2025.1
+      git clone https://github.com/stackhpc/kayobe -b stackhpc/|current_release_git_branch_name|
       cd kayobe/ansible/roles/kolla-ansible/templates/
-      sdiff -w 200 overcloud-services.j2 /home/stack/2025.1-upgrade/src/kayobe-config/etc/kayobe/kolla/inventory/overcloud-services.j2
-      sdiff -w 200 overcloud-components.j2 /home/stack/2025.1-upgrade/src/kayobe-config/etc/kayobe/kolla/inventory/overcloud-components.j2
+      sdiff -w 200 overcloud-services.j2 "$KAYOBE_CONFIG_PATH"/kolla/inventory/overcloud-services.j2
+      sdiff -w 200 overcloud-components.j2 "$KAYOBE_CONFIG_PATH"/kolla/inventory/overcloud-components.j2

-      sdiff -w 200 overcloud-services.j2 /home/stack/2025.1-upgrade/src/kayobe-config/etc/kayobe/environments/<env>/kolla/inventory/overcloud-services.j2
-      sdiff -w 200 overcloud-components.j2 /home/stack/2025.1-upgrade/src/kayobe-config/etc/kayobe/environments/<env>/kolla/inventory/overcloud-components.j2
+      sdiff -w 200 overcloud-services.j2 "$KAYOBE_CONFIG_PATH"/environments/"$KAYOBE_ENVIRONMENT"/kolla/inventory/overcloud-services.j2
+      sdiff -w 200 overcloud-components.j2 "$KAYOBE_CONFIG_PATH"/environments/"$KAYOBE_ENVIRONMENT"/kolla/inventory/overcloud-components.j2

Also applies to: 978-979

Source: MCP tools