Bugzilla will be upgraded to version 5.0. The upgrade date is tentatively scheduled for 2 December 2018, pending final testing and feedback.
Bug 1449842 - [RFE] Need to correct guide to reflect virt-who.d configuration naming requirements
[RFE] Need to correct guide to reflect virt-who.d configuration naming requir...
Status: CLOSED CURRENTRELEASE
Product: Red Hat Satellite 6
Classification: Red Hat
Component: Docs Virtual Instances Guide (Show other bugs)
6.2.9
Unspecified Unspecified
urgent Severity high (vote)
: 6.2.10
: Unused
Assigned To: Michaela Slaninkova
Russell Dickenson
: FutureFeature, PrioBumpGSS
Depends On:
Blocks:
  Show dependency treegraph
 
Reported: 2017-05-10 17:19 EDT by Craig Donnelly
Modified: 2018-08-31 11 EDT (History)
5 users (show)

See Also:
Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of:
Environment:
Last Closed: 2017-05-25 05:57:26 EDT
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---


Attachments (Terms of Use)

  None (edit)
Description Craig Donnelly 2017-05-10 17:19:31 EDT
Document URL: https://access.redhat.com/documentation/en-us/red_hat_satellite/6.2/html-single/virtual_instances_guide/#virt_who_configuration_files

Section Number and Name: 5.1. VIRT-WHO CONFIGURATION FILES

Describe the issue: At the time this documentation was written, any file with any or no extension, could be used as a config file inside '/etc/virt-who.d/'.

With the release of virt-who-0.19.x+ this is no longer the case.
We should cover all of this documentation relating to configuration in the virt-who.d drop directory to note that all usable config files must have the '.conf' suffix. (ex. rhev1.conf, vsphere22.conf, etc..)

Anything without '.conf' as the suffix will now be completely ignored as a configuration file in this directory. (No longer a universal drop directory)

Suggestions for improvement: 

Additional information: 

This is already live in RHEL 6's current release of virt-who.
There is still a BZ in progress for RHEL 7's next release, that also is working to include correction to the error we will see if we cannot find a config file ending in '.conf' here: https://bugzilla.redhat.com/show_bug.cgi?id=1369107
Comment 1 Craig Donnelly 2017-05-10 17:20:37 EDT
Note:

This needs to be evaluated for the entire 5.x section of the guide to ensure all instances of reference to configuration in '/etc/virt-who.d/' are changed to reflect the '.conf' suffix requirement.
Comment 2 Craig Donnelly 2017-05-10 17:33:21 EDT
Looking for a place to clone this BZ in relation to additional copy of this documentation that will also need to be identically updated: https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1.0/html-single/virtual_instances_guide/
Comment 3 Andrew Dahms 2017-05-14 19:02:30 EDT
Assigning to Michaela for review.

Michaela - it looks like we will need the following changes:

* A second 'Note' box at the top of Section 5.1 that tells users that the conf
  files in the directory mentioned in the summary above must end in .conf when
  the version of virt-who is 'virt-who-0.19' or above.

* Change item 4. in Section 5.1.2 to '/etc/virt-who.d/*.conf'

* Change the conf file name in Step 2. of Section 5.3 from 'rhevmhost1' to 
  'rhevmhost1.conf'

* Change the conf file name in Step 4. of Section 5.4 from 'rhelhost1' to
  'rhelhost1.conf'

* Change the conf file name in Step 2. of Section 5.5 from 'vcenterhost1' to
  'vcenterhost1.conf'

A brief look over the chapter to see any other instances of conf files that could be similarly renamed may also be a good idea.
Comment 8 Michaela Slaninkova 2017-05-25 05:57:26 EDT
These changes are now live on the customer portal.

Note You need to log in before you can comment on or make changes to this bug.