Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1668245

Summary:	gluster(8) - Man page - create gluster example session
Product:	[Community] GlusterFS	Reporter:	Prerna Sony <psony>
Component:	core	Assignee:	sameer kandarkar <skandark>
Status:	CLOSED UPSTREAM	QA Contact:
Severity:	medium	Docs Contact:
Priority:	medium
Version:	mainline	CC:	amukherj, bugs, skandark, srakonde
Target Milestone:	---	Keywords:	EasyFix, StudentProject, ZStream
Target Release:	---	Flags:	skandark: needinfo- skandark: needinfo-
Hardware:	All
OS:	Linux
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:	1667963	Environment:
Last Closed:	2020-03-12 12:48:09 UTC	Type:	---
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:	1667963

Description Prerna Sony 2019-01-22 09:55:41 UTC

+++ This bug was initially created as a clone of Bug #1667963 +++

Document URL: 

man 8 gluster

Section Number and Name: 

N/A

Describe the issue: 

Create a new session called EXAMPLES to gluster(8) as quick reference for usage help, or even a new man page, something like gluster(7).

Suggestions for improvement: 

An EXAMPLE session would be a good addition to Gluster man pages.

One very good example that comes to mind is LVMTHIN(7).

Additional information:

Comment 1 Atin Mukherjee 2019-06-09 05:38:13 UTC

Ping! Any work being done on this?

Comment 2 Sanju 2019-07-18 08:00:28 UTC

Any update on this?

Comment 3 sameer kandarkar 2019-09-20 10:57:17 UTC

Hello Team,


Our expectations here are, that we should have a 'Examples' section in gluster's man page. 

For example:

We have information like this:
~~~
 volume create <NEW-VOLNAME> [stripe <COUNT>] [replica <COUNT>] [disperse [<COUNT>]] [redundancy <COUNT>] [transport <tcp|rdma|tcp,rdma>] <NEW-BRICK> ...
~~~

We should also include the command's use an an example(Like This):
~~~
Three way replicated volume:
# gluster volume create test-volume replica 3 transport tcp server1:/rhgs/brick1 server2:/rhgs/brick2 server3:/rhgs/brick3


# Volume Name: test-volume
Type: Replicate
Volume ID: 372e9c3d-b793-470d-b26e-5902bf609845
Status: Stopped
Snapshot Count: 1
Number of Bricks: 1 x 3 = 3
Transport-type: tcp
Bricks:
Brick1: server1:/rhgs/brick1
Brick2: server2:/rhgs/brick2
Brick3: server3:/rhgs/brick2


Arbitrated Replicated Volumes:
gluster volume create VOLNAME replica 3 arbiter 1 server1:/rhgs/brick1 server2:/rhgs/brick2 server3:/rhgs/brick3


# gluster volume info testvol
Volume Name: testvol
Type: Distributed-Replicate
Volume ID: ed9fa4d5-37f1-49bb-83c3-925e90fab1bc
Status: Created
Snapshot Count: 0
Number of Bricks: 1 x (2 + 1) = 3
Transport-type: tcp
Bricks:
Brick1: server1:/rhgs/brick1
Brick2: server2:/rhgs/brick2
Brick3: server3:/rhgs/brick3 (arbiter)

~~~

So that new users will get a clear idea about the commands ,with the man page also.


We can check the  LVMTHIN(7) man page which is designed in a similar way.
----------------------------------
3. create ThinPoolLV
       Combine the data and metadata LVs into a thin pool LV.
       ThinDataLV is renamed to hidden ThinPoolLV_tdata.
       ThinMetaLV is renamed to hidden ThinPoolLV_tmeta.
       The new ThinPoolLV takes the previous name of ThinDataLV.

       lvconvert --type thin-pool --poolmetadata VG/ThinMetaLV VG/ThinDataLV

       Example
       # lvconvert --type thin-pool --poolmetadata vg/pool0meta vg/pool0

       # lvs vg/pool0
         LV    VG Attr       LSize  Pool Origin Data% Meta%
         pool0 vg twi-a-tz-- 10.00g      0.00   0.00

       # lvs -a
         LV            VG Attr       LSize
         pool0         vg twi-a-tz-- 10.00g
         [pool0_tdata] vg Twi-ao---- 10.00g
         [pool0_tmeta] vg ewi-ao---- 1.00g

---------------------------------- 


Regards,
Sameer

Comment 4 Sanju 2020-01-31 10:56:38 UTC

Any update?

Comment 5 Worker Ant 2020-03-12 12:48:09 UTC

This bug is moved to https://github.com/gluster/glusterfs/issues/953, and will be tracked there from now on. Visit GitHub issues URL for further details

Comment 6 Red Hat Bugzilla 2023-09-14 04:45:26 UTC

The needinfo request[s] on this closed bug have been removed as they have been unresolved for 1000 days