Bug 1647780

Summary: Heketi Architecture diagram is neither self explanatory nor has any details explaining it
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: Nag Pavan Chilakam <nchilaka>
Component: doc-Administration_GuideAssignee: Anjana KD <akrishna>
doc-Administration_Guide sub component: Default QA Contact: Bala Konda Reddy M <bmekala>
Status: CLOSED CURRENTRELEASE Docs Contact:
Severity: medium    
Priority: unspecified CC: apaladug, asriram, bmekala, nlevinki, rhs-bugs, rmusil, rtalur, rwheeler, storage-doc, vdas
Version: rhgs-3.4Keywords: ZStream
Target Milestone: ---   
Target Release: RHGS 3.4.z Async Update   
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: 2019-02-08 18:37:15 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: 1660873    

Description Nag Pavan Chilakam 2018-11-08 10:48:56 UTC
Description of problem:
===========================
in section 5.2. Managing Volumes using Heketi, there is a heketi architecture diagram.
I am unable to deduce anything meaningful from this.
What is it that we are trying to convey with the diagram, as it is neither self-explanatory nor is there explanation on the architecture.



Version-Release number of selected component (if applicable):
================
3.4

https://access.redhat.com/documentation/en-us/red_hat_gluster_storage/3.4/html-single/administration_guide/#idm139709658546720

figure 5.1

expected result:
either give some details on the diagram, or else have a more meaningful diagram which will be self explanatory

Comment 4 Anjana KD 2019-01-28 06:09:11 UTC
Based on discussion with Rtalur

I will be incorporating the following changes in section 5.2 https://access.redhat.com/documentation/en-us/red_hat_gluster_storage/3.4/html-single/administration_guide/#idm140101766170416 :

1. Changing the description 

  Figure 5.1 Heketi Architecture--> Heketi Volume Creation

2 The explanation for the figure

 In the diagram above, a create volume request to heketi leads heketi to select bricks spread across 2 zones and 4 nodes. After the volume is created in Red Hat Gluster Storage, heketi provides the volume information to the service which made the request.

Comment 5 Anjana KD 2019-01-31 04:10:10 UTC
Hi Bala,

I have added the above-mentioned changes.

Preview link: https://doc-stage.usersys.redhat.com/documentation/en-us/red_hat_gluster_storage/3.4/html-single/administration_guide/#idm140487424165456


Kindly review.