Feature Overview (mandatory - Complete while in New status)

This feature covers the deprecation and removal of the os-diff tool from Red Hat OpenStack Services on OpenShift product. The os-diff tool, previously used to compare configuration files between RHOSP environments and RHOSO environments during the upgrade/adoption process.

It will be retired in favor of simpler and standardized bash commands available directly via the CLI. 

Goals (mandatory - Complete while in New status)

• Fully retire the os-diff package from RHOSO delivery.

• Remove references to os-diff from the RHOSP 17.1 to RHOSO 18 adoption guide documentation.

• Provide alternative documented procedures through a KCS article detailing how to achieve equivalent functionality using bash commands.

Who benefits from this Feature, and how?

• Customers and support teams will benefit from simplified processes and reduced complexity.

• Delivery teams benefit by reducing the number of maintained components, thus simplifying their workflow.

What is the difference between today’s current state and a world with this Feature? Currently, users rely on os-diff, a specialized tool requiring package maintenance. After implementation, users will achieve the same outcomes using native bash commands.

Requirements (mandatory - Complete while in Refinement status):

Done - Acceptance Criteria (mandatory - Complete while in Refinement status):

• All os-diff packages are no longer shipped or available in the RHOSO repositories.

• RHOSP 17.1 to RHOSO 18 adoption guide and other related documentation no longer reference os-diff.

• A published KCS article clearly describes how to achieve configuration comparisons previously handled by os-diff using bash commands, validated by the documentation and support teams.

Use Cases - i.e., User Experience & Workflow: (Initial completion while in Refinement status):

Main Success Scenario:

1. User needs to compare configuration files between RHOSP 17.1 and RHOSO 18 environment.

1. User accesses the KCS article detailing bash-based comparison methods.

1. User follows documented commands and successfully compares configurations without requiring additional software.

Out of Scope (Initial completion while in Refinement status):

• TBD

Documentation Considerations (Initial completion while in Refinement status):

• Update existing adoption documentation to remove mentions of os-diff.

• Develop a CLI-based replacement procedures clearly documented in the KCS article.

Questions to Answer (Initial completion while in Refinement status):

• Are there specific configurations or scenarios where bash CLI-based comparisons might require special handling or limitations?

Background and Strategic Fit (Initial completion while in Refinement status):

• Reducing tool proliferation and standardizing on core utilities aligns with Red Hat’s strategic goals of simplification and reduced maintenance overhead.

Customer Considerations (Initial completion while in Refinement status):

• Ensure clear communication of the retirement timeline and availability of alternative documentation to avoid disruption.

• Provide transition guidance in release notes.