Bug 693948 - 3 incorrect information in Doc-dm-multipath (RHEL 6.1 Beta)
Summary: 3 incorrect information in Doc-dm-multipath (RHEL 6.1 Beta)
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Linux 6
Classification: Red Hat
Component: doc-DM_Multipath
Version: 6.1
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: rc
: ---
Assignee: Steven J. Levine
QA Contact: ecs-bugs
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2011-04-06 03:28 UTC by Gris Ge
Modified: 2011-05-23 20:39 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2011-05-23 20:39:52 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Gris Ge 2011-04-06 03:28:07 UTC
Description of problem:
(PDF page number)
1. Page 29, default path_checker should be 'directio'
2. Page 28, default path_grouping_policy is 'failover'
3. page 39: 
For each path:
`- host:channel:id:lun devnode major:minor path_status dm_status_if_known

The correct order: "[dm_status_if_known] [path_status]"

I have no idea about the third item in:
  `- 103:0:0:0 sdd 8:48   active ready running
Might need dev guy's comments.

Version-Release number of selected component (if applicable):
DM multipath RHEL 6.1 Beta 

How reproducible:
100%

Steps to Reproduce:
1. Download Red_Hat_Enterprise_Linux-96-DM_Multipath-en-US.pdf
2. Check page 28 29 39
  
Actual results:
Incorrect information

Expected results:
Correct info

Additional info:

Comment 1 Steven J. Levine 2011-04-06 17:41:38 UTC
Ben:

I need your confirmation on whether this information is actually correct. This may be a confusion over the issue of default values vs. compiled-in values.

Points 1 and 2 refer to table 4.1, path_checker and path_grouping_policy descriptions:

http://documentation-stage.bne.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/96/html/DM_Multipath/config_file_defaults.html

Point 3 refers to the multipath command output described in section 5.5:

http://documentation-stage.bne.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/96/html/DM_Multipath/MPIO_output.html

This bug gives output to the command that does seem to have one more field than is described in the document.

-Steven

Comment 2 Ben Marzinski 2011-04-08 15:18:05 UTC
Yes. The bug is correct.

In table 4.1, the default path_checker should be 'directio', and the default path_grouping_policy should be 'failover'

In section 5.5, the path format should read
 `- host:channel:id:lun devnode major:minor dm_status_if_known path_status online_status

Also the possible path_status values of a path that is working correctly are "ready" or "ghost" (not active) and the possible path_status values of a path that is not working correctly are "faulty" and "shaky" (not failed)

"active" and "failed" are returned for the dm_status_if_know, and your description of them is correct.

The possible values for online_status are "running" and "offline".  "offline" means that this scsi device has been disabled.

Comment 3 Steven J. Levine 2011-04-08 16:19:02 UTC
Thanks, Ben. And thanks Gris for finding this. I'll be able to get those corrections into the document in time for the RHEL 6.1 release.

Comment 4 Steven J. Levine 2011-04-08 16:29:08 UTC
Ben:

(Sorry to put this back in NEEDINFO, but this yields another question...)

The bug refers to table 4.1 (multipath configuration defaults), but Table 4.3 (device attributes) also gives readsector0 as the default value for path_checker. Should that be directio as well?

Table 4-2 (multipath attributes) and Table 4.3 (device attributes) give no default value for path_grouping_policy. Should I note a default value of failover in those tables?

Table 4-2:
http://documentation-stage.bne.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/96/html/DM_Multipath/config_file_multipath.html

Table 4-3:
http://documentation-stage.bne.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/96/html/DM_Multipath/config_file_devices.html

-Steven

Comment 5 Steven J. Levine 2011-04-08 16:34:33 UTC
I think I forgot to specify Ben for the NEEDINFO...

Comment 6 Ben Marzinski 2011-04-08 17:15:26 UTC
Actually, I don't think I would include defaults in the devices or multipaths attribute tables at all.  The way multipath.conf works, if a device has a multipaths section, and the attribute is specified there, that value is used. Otherwise, if the device has a devices section and the attribute is specified there, that value is used.  Otherwise if there is a defaults section and the attribute is specified there, that one is used. If the value is not configured anywhere, then the default is used.

Putting defaults in the devices and multipaths sections seems a little misleading, because if a user doesn't set an attribute there, mutipath just checks for it at a more general level.  If it is set in the more general level, then multipath won't be using the default.

Comment 7 Steven J. Levine 2011-04-11 15:09:28 UTC
In my current working 6.1 draft of the DM-Multipath manual, I have corrected the errors noted in this bug and confirmed by Ben. I have also removed the default values from tables 4-2 and 4-3. This updates will be reflected in the RHEL 6.1 release.

Comment 8 Steven J. Levine 2011-04-14 15:16:00 UTC
The manual with the corrections has been checked into SVN and built on the Brew server so I am moving this bug to MODIFIED.

Comment 10 Steven J. Levine 2011-05-10 14:23:29 UTC
Red_Hat_Enterprise_Linux-DM_Multipath-6-web-en-US-1-38.el5

The default values for path_checker and path_grouping_policy have been fixed in Table 4-1:

http://documentation-stage.bne.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/DM_Multipath/config_file_defaults.html

Section 5.7 now includes the corrected path format output:

http://documentation-stage.bne.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/DM_Multipath/MPIO_output.html

Comment 11 Andrew Ross 2011-05-11 02:44:56 UTC
Verified: Red_Hat_Enterprise_Linux-DM_Multipath-6-web-en-US-1-38.el5

(In reply to comment #2)
> Yes. The bug is correct.
> 
> In table 4.1, the default path_checker should be 'directio', and the default
> path_grouping_policy should be 'failover'
> 

fixed

> In section 5.5, the path format should read
>  `- host:channel:id:lun devnode major:minor dm_status_if_known path_status
> online_status
> 

fixed

> Also the possible path_status values of a path that is working correctly are
> "ready" or "ghost" (not active) and the possible path_status values of a path
> that is not working correctly are "faulty" and "shaky" (not failed)
> 

fixed: "the status of the path is ready or ghost. If the path is down, the status is faulty or shaky." 

> "active" and "failed" are returned for the dm_status_if_know, and your
> description of them is correct.
> 
> The possible values for online_status are "running" and "offline".  "offline"
> means that this scsi device has been disabled.

fixed: "The possible values for online_status are running and offline. A status of offline means that this scsi device has been disabled. "

Comment 12 Steven J. Levine 2011-05-23 20:39:52 UTC
With the release of RHEL 6.1, I am closing this bug.


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