Uploaded image for project: 'RHEL'
  1. RHEL
  2. RHEL-113763

pcs resource describe: preserve formatting of longdesc [rhel-9]

Linking RHIVOS CVEs to...Migration: Automation ...SWIFT: POC ConversionSync from "Extern...XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Normal Normal
    • rhel-9.8
    • rhel-9.6
    • pcs
    • No
    • Moderate
    • rhel-ha
    • 0
    • False
    • False
    • Hide

      None

      Show
      None
    • Yes
    • None
    • Bug Fix
    • Hide
      Cause:
      Pcs was wrapping resource and stonith agent descriptions to make them fit into the terminal.

      Consequence:
      Any formatting done in the description, such as paragraphs, lists, tables, new lines was removed, making the description hard to read.

      Fix:
      The description is no longer reformatted by pcs.

      Result:
      Resource and stonith agent description is formatted the way agents' authors intended.
      Show
      Cause: Pcs was wrapping resource and stonith agent descriptions to make them fit into the terminal. Consequence: Any formatting done in the description, such as paragraphs, lists, tables, new lines was removed, making the description hard to read. Fix: The description is no longer reformatted by pcs. Result: Resource and stonith agent description is formatted the way agents' authors intended.
    • Proposed
    • Unspecified
    • Unspecified
    • Unspecified
    • None

      This is a clone of issue RHEL-111451 to use for version rhel-9.8

      Original description:

      What were you trying to do that didn't work?

      Run `pcs resource describe` for an agent that has multi-line londesc.

      What is the impact of this issue to you?

      Makes descriptions for azure-events* and some other agents that show all the steps divided by lines and other info into a one-line description that is hard to read.

      Please provide the package NVR for which the bug is seen:

      pcs-0.11.9-2.el9_6.1.x86_64

      How reproducible is this bug?:

      100%

      Steps to reproduce

      1. pcs resource describe ocf:heartbeat:azure-events
        ocf:heartbeat:azure-events - Microsoft Azure Scheduled Events monitoring agent

      This resource agent implements a monitor for scheduled (maintenance) events for a Microsoft Azure VM.  If any relevant events are found, it moves all Pacemaker resources away from the affected
      node to allow for a graceful shutdown.         Usage:          [OCF_RESKEY_eventTypes=VAL] [OCF_RESKEY_verbose=VAL] azure-events ACTION                action (required): Supported values:
      monitor, help, meta-data           eventTypes (optional): List of event types to be considered                             relevant by the resource agent (comma-separated).
      Supported values: Freeze,Reboot,Redeploy                                Default = Reboot,Redeploy /             verbose (optional): If set to true, displays debug info.
      Default = false         Deployment:             crm configure primitive rsc_azure-events ocf:heartbeat:azure-events                     op monitor interval=10s                 crm configure
      clone cln_azure-events rsc_azure-events  For further information on Microsoft Azure Scheduled Events, please refer to the following documentation: https://docs.microsoft.com/en-us/azure/virtual-
      machines/linux/scheduled-events

      Resource options:
      ...

      Expected results

      Description is shown as intended, e.g.

      OCF_ROOT=/usr/lib/ocf /usr/lib/ocf/resource.d/heartbeat/azure-events meta-data
      <?xml version="1.0"?>
      <!DOCTYPE resource-agent SYSTEM "ra-api-1.dtd">
      <resource-agent name="azure-events" version="1.0">
      <version>1.0</version>
      <longdesc lang="en">
      This resource agent implements a monitor for scheduled
      (maintenance) events for a Microsoft Azure VM.
      
      If any relevant events are found, it moves all Pacemaker resources
      away from the affected node to allow for a graceful shutdown.
      
      	Usage:
      		[OCF_RESKEY_eventTypes=VAL] [OCF_RESKEY_verbose=VAL] azure-events ACTION
      
      		action (required): Supported values: monitor, help, meta-data
      		eventTypes (optional): List of event types to be considered
      				relevant by the resource agent (comma-separated).
      				Supported values: Freeze,Reboot,Redeploy
      				Default = Reboot,Redeploy
      /		verbose (optional): If set to true, displays debug info.
      				Default = false
      
      	Deployment:
      		crm configure primitive rsc_azure-events ocf:heartbeat:azure-events 			op monitor interval=10s
      		crm configure clone cln_azure-events rsc_azure-events
      
      For further information on Microsoft Azure Scheduled Events, please
      refer to the following documentation:
      https://docs.microsoft.com/en-us/azure/virtual-machines/linux/scheduled-events
      
      </longdesc>
      ...
      

      Actual results

      The description becomes a hard to read one-liner.

              mpospisi@redhat.com Michal Pospisil
              watson-automation Watson Automation
              Tomas Jelinek Tomas Jelinek
              Cluster QE Cluster QE
              Michal Stubna Michal Stubna
              Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

                Created:
                Updated: