Bug 1456575

Summary: [Doc] : Document workaround to use "localhost" instead of --client <hostname> for libgfapi statedumps
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: Ambarish <asoman>
Component: doc-Administration_GuideAssignee: Pratik Mulay <pmulay>
doc-Administration_Guide sub component: Default QA Contact: Ambarish <asoman>
Status: CLOSED CURRENTRELEASE Docs Contact:
Severity: high    
Priority: unspecified CC: asriram, bturner, jthottan, kkeithle, mbenjamin, mhideo, nlevinki, rhinduja, rhs-bugs, rwheeler, sasundar, skoduri, storage-doc
Version: rhgs-3.3   
Target Milestone: ---   
Target Release: RHGS 3.3.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-09-21 04:29:04 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1417157    

Description Ambarish 2017-05-29 16:08:24 UTC
Describe the issue: 
--------------------

This comes as a consequence of https://bugzilla.redhat.com/show_bug.cgi?id=1454311.

The document should clearly guide the sysadmin to take libgfapi statedumps on Ganesha or Samba setups without using the CLI "client" param,and instead use localhost:<PID of Ganesha/Samba>

Or else statedumps won't dump the state for Ganesha/Samba at all.


I'll leave it on the Doc team to decide the section etc.

LMK if any help is needed from my side.

Comment 6 Ambarish 2017-07-29 13:08:16 UTC
Pratik,

The command to take the statdump isn't correct.

This is what the attached Doc says :

<snip>
# gluster volume statedump VOLNAME localhost:pid
</snip>

^
The command won't run and will fail.


Plz change this to 


<snip>
# gluster volume statedump VOLNAME client localhost:<pid of running Samba/Ganesha process>
</snip>


EXAMPLE FROM MY SETUP :

[root@gqas007 ~]# gluster v statedump testvol localhost:18745
Error parsing options
Usage: volume statedump <VOLNAME> [[nfs|quotad] [all|mem|iobuf|callpool|priv|fd|inode|history]... | [client <hostname:process-id>]]
[root@gqas007 ~]# 

[root@gqas007 ~]# gluster v statedump testvol client localhost:18745
volume statedump: success
[root@gqas007 ~]# 


Also,can you change the text to,"To take the statedump of a  running Ganesha/Samba process....."


I am moving this bug back to Assigned for a re-look from CCS.

Comment 7 Pratik Mulay 2017-08-03 15:55:48 UTC
(In reply to Ambarish from comment #6)
> Pratik,
> 
> The command to take the statdump isn't correct.
> 
> This is what the attached Doc says :
> 
> <snip>
> # gluster volume statedump VOLNAME localhost:pid
> </snip>
> 
> ^
> The command won't run and will fail.
> 
> 
> Plz change this to 
> 
> 
> <snip>
> # gluster volume statedump VOLNAME client localhost:<pid of running
> Samba/Ganesha process>
> </snip>
> 
> 
> EXAMPLE FROM MY SETUP :
> 
> [root@gqas007 ~]# gluster v statedump testvol localhost:18745
> Error parsing options
> Usage: volume statedump <VOLNAME> [[nfs|quotad]
> [all|mem|iobuf|callpool|priv|fd|inode|history]... | [client
> <hostname:process-id>]]
> [root@gqas007 ~]# 
> 
> [root@gqas007 ~]# gluster v statedump testvol client localhost:18745
> volume statedump: success
> [root@gqas007 ~]# 
> 
> 
> Also,can you change the text to,"To take the statedump of a  running
> Ganesha/Samba process....."
> 
> 
> I am moving this bug back to Assigned for a re-look from CCS.

Hi Ambarish,

I've made the requested change. Please find the same on the following preview link:

https://access.qa.redhat.com/documentation/en-us/red_hat_gluster_storage/3.3/html-single/administration_guide/#statedump-usage-client

Moving bug back to ON_QA. Let me know in case of any concerns.

Comment 8 Ambarish 2017-08-10 04:10:13 UTC
Hi Pratik,

Couple other pointers.

1) The note you mentioned should not be under 19.8.2. "Gathering information from the client".Samba/Ganesha aren't client processes,they run on the server."19.8.1. Gathering information from the server" should be an accurate place to place this note.


2) As I mentioned in https://bugzilla.redhat.com/show_bug.cgi?id=1456575#c6,plz reword "If you need to see the state of its clients" to something like "to take the statedump of a running Samba/Ganesha process...."


I am moving this out of QE bucket for the required changes.

Comment 9 Pratik Mulay 2017-08-22 11:08:26 UTC
Hi Ambarish,

I've made the requested changes. Following is the Preview link for the same:

https://access.qa.redhat.com/documentation/en-us/red_hat_gluster_storage/3.3/html-single/administration_guide/#statedump-usage-server

Let me know in case of any concerns. Have a great day ahead.

Comment 10 Ambarish 2017-08-28 12:27:18 UTC
LGTM Pratik,Thanks!

Moving to Verified.