Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-20896

History support in OCM.io discovered policies (UI)

XMLWordPrintable

    • Product / Portfolio Work
    • False
    • Hide

      None

      Show
      None
    • False
    • Not Selected

      Feature Overview

      This feature focuses on updating the Governance console UI to restore and unify the policy violation history for all policies, including both framework-deployed and Discovered Policies. This work includes moving the history page from its old location into a dedicated tab within the Policy details page for a consistent, consolidated user experience.

      Goals

      This Section: Provide high-level goal statement, providing user context
      and expected user outcome(s) for this feature

      • Restore the ability for users to view the policy event history for all OCM.io policies (framework and Discovered) in the UI.
      • Consolidate the user experience by moving the existing policy event history page into a dedicated tab within the Policy details view.
      • Ensure the policy details page for all policy kinds (Policy, ConfigurationPolicy, etc.) presents a consistent user interface for accessing history.
      • Close a feature gap between framework-deployed and externally deployed OCM.io policies.

      Requirements

      This Section: A list of specific needs or objectives that a Feature must
      deliver to satisfy the Feature.. Some requirements will be flagged as MVP.
      If an MVP gets shifted, the feature shifts. If a non MVP requirement slips,
      it does not shift the feature.

      Requirement Notes isMvp?
      The UI MUST be updated to retrieve and display the last 10 compliance events by querying the policy template resources (e.g., ConfigurationPolicy status), which now contain the event data.    YES
      The existing policy history page MUST be moved and displayed as a new tab (e.g., "History" or "Event History") within the Policy details page.    YES
      The existing "View history" link on the Policy details > Results page MUST be updated to link directly to the new "History" tab.    YES
      The new "History" tab MUST be available and correctly populated with event data for both policies deployed via the RHACM framework and policies deployed via alternative methods (Discovered Policies).   YES
      UI must gracefully handle cases where no history events are present.   YES
      CI - MUST be running successfully with test automation This is a
      requirement for ALL features.
      YES
      Release Technical Enablement Provide necessary release enablement details
      and documents.
      YES

      (Optional) Use Cases

      This Section:

      • Main success scenarios - high-level user stories
        • As an ACM administrator, I want to view the compliance history for a Discovered Policy to quickly understand the timeline of compliance status changes.
        • As an operator, I want all policy-related information (details, results, and history) to be consolidated into one page for a streamlined troubleshooting process.
        • As an auditor, I can easily access a chronological log of the last compliance events for any policy using a consistent UI across my entire fleet.
      • Alternate flow/scenarios - high-level user stories
        • When navigating the console, the user should be seamlessly redirected to the new "History" tab, rather than a standalone page, when clicking an old history link.

      Questions to answer

      • ...

      Out of Scope

      • Any changes to the policy controller or backend API logic responsible for collecting and storing the history data. This feature assumes the necessary history data is already being written to the policy template resource status fields.
      • Implementing long-term archival storage or a searchable history service beyond the events retrieved from the policy resource itself.

      Background, and strategic fit

      This Section: What does the person writing code, testing, documenting
      need to know? What context can be provided to frame this feature?

      The historical method of tracking policy events relied on a Policy CR that is not present when policies are deployed via alternative methods (Discovered Policies), which resulted in a broken history feature. While the backend has been updated to fix the data source, the UI still needs to be adjusted to retrieve history from the new location and present it to the user.

      This feature is critical for closing the functionality gap between policies deployed using the RHACM framework and those deployed externally. Moving the history to a tab within the Policy details page aligns with modern UX standards, improves user workflow by reducing navigation, and creates a single, consistent place for all policy-related information, regardless of the policy's origin.

      Assumptions

      • The new backend logic is complete and reliably populates the last 10 compliance events into the status of policy template resources (e.g., ConfigurationPolicy).
      • The UI has access (via Search or a dedicated API) to efficiently query and retrieve these status fields from the underlying policy template resources.

      Customer Considerations

      • Customers who deploy policies using external tools will regain a crucial auditing and debugging feature (violation history).
      • The consolidation of policy information into one view will enhance overall usability and reduce the cognitive load when troubleshooting compliance issues.

      Documentation Considerations

      Questions to be addressed:

      • What educational or reference material (docs) is required to support this
        product feature? For users/admins? Other functions (security officers, etc)?
        • Yes, for administrators and operators.
      • Does this feature have a doc impact?
        • Yes, update "Policy deployment comparison table" doc
          • Feature:  Compliance history
          • Deployed with external tools
            • Change something similar to Policy framework column; e.g. "You can view the last 10 events..."
      • New Content, Updates to existing content, Release Note, or No Doc Impact
      • If unsure and no Technical Writer is available, please contact Content
        Strategy.
      • What concepts do customers need to understand to be successful in
        [action]?
        • The new location and name of the history feature within the policy details view.
        • That history is now available for all OCM.io policies regardless of deployment method.
      • How do we expect customers will use the feature? For what purpose(s)?
        • To investigate the cause of violation flips and audit violation status changes.
      • What reference material might a customer want/need to complete [action]?
      • Is there source material that can be used as reference for the Technical
        Writer in writing the content? If yes, please link if available.
      • What is the doc impact (New Content, Updates to existing content, or
        Release Note)?
        • Updates to existing content; update "Policy deployment comparison table" doc
          • Feature:  Compliance history
          • Deployed with external tools
            • Change something similar to Policy framework column; e.g. "You can view the last 10 events..."

              showeimer Sho Weimer
              gparvin-redhat Gus Parvin
              Derek Ho Derek Ho
              Sho Weimer Sho Weimer
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: