Dev: ra: Show parameters more clearly

[liangxin1300]

Changes for ra info output

• Show ra name in headers

# new
ocf:heartbeat:IPaddr2 - Manages virtual IPv4 and IPv6 addresses (Linux specific version)
# original
Manages virtual IPv4 and IPv6 addresses (Linux specific version) (ocf:heartbeat:IPaddr2)

• Mark deprecated parameters (mentioned in Confusing information from crm ra info regarding fence agent parameters #1731)

# new
debug (deprecated) (string): Write debug information to given file
# original
debug (string): Write debug information to given file

• Show what this parameter obsoleted (mentioned in Confusing information from crm ra info regarding fence agent parameters #1731)

# new
ip* (obsoletes: ipaddr) (string): IP address or hostname of fencing device
# original
ip* (string): IP address or hostname of fencing device

• Don't show parameter as required, which deprecated

# new
ip* (obsoletes: ipaddr) (string): IP address or hostname of fencing device
ipaddr (deprecated) (string): IP address or hostname of fencing device
username* (obsoletes: login) (string): Login name
login (deprecated) (string): Login name
# original
ip* (string): IP address or hostname of fencing device
ipaddr* (string): IP address or hostname of fencing device
username* (string): Login name
login* (string): Login name

• Show short description for FA

# new
stonith:fence_ifmib - Fence agent for IF MIB
# original
stonith:fence_ifmib

• Show required parameters first, then others in alphabetical order, at last, show those deprecated parameters

[nicholasyang2022]

Too noisy. The original format, using * to denote required parameters is more readable.

[liangxin1300]

Too noisy. The original format, using * to denote required parameters is more readable.

I thought this could be unified with the format like *** Advanced Use Only *** and *** Automatically generated by pacemaker ***

[liangxin1300]

This PR also fix #1724

# crm_resource --show-metadata stonith:fence_virsh|grep "required=\"1\""|grep -v deprecated
    <parameter name="ip" unique="0" required="1" obsoletes="ipaddr">
    <parameter name="username" unique="0" required="1" obsoletes="login">

crm(live/alp-1)configure# primitive st_virsh fence_virsh
crm(live/alp-1)configure# commit
(unpack_config)         warning: Blind faith: not fencing unseen nodes
ERROR: st_virsh: required parameter "ip" not defined
ERROR: st_virsh: required parameter "username" not defined
Do you still want to commit  (y/n)?

[nicholasyang2022]

I thought this could be unified with the format like *** Advanced Use Only *** and *** Automatically generated by pacemaker ***

Apparently, required fields does not need such strong user attention compared to advanced use only fields. And deprecated/obsoleted fields should attract less user attention than other fields.

[liangxin1300]

And deprecated/obsoleted fields should attract less user attention than other fields.

Then how to mark them?

[nicholasyang2022]

And deprecated/obsoleted fields should attract less user attention than other fields.

Then how to mark them?

We can sort the parameters, displaying required ones first, and then other common parameters, and lastly deprecated ones. And it is enough to use (deprecated) to mark them.

Or we can display deprecated parameters in a separated section after other parameters, so that users can ignore the entire section when they don't need them.

[liangxin1300]

We can sort the parameters, displaying required ones first, and then other common parameters, and lastly deprecated ones. And it is enough to use (deprecated) to mark them.

Changed

[nicholasyang2022]

Tested. LGTM.