[Gluster-infra] Proposal for adding FAQ in gluster-users

[Saravanakumar Arumugam]

On 08/27/2015 06:48 PM, Humble Chirammal wrote:
>
>
> On 08/27/2015 03:55 PM, Vijay Bellur wrote:
>> On Wednesday 26 August 2015 04:13 PM, Saravanakumar Arumugam wrote:
>>> Hi,
>>>
>>> I have a small Proposal.
>>>
>>> Can we add a FAQ page in
>>> http://www.gluster.org/mailman/listinfo/gluster-users
>>>
>>> This is can something similar like this:
>>>      link: https://www.redhat.com/mailman/listinfo/libguestfs
>>>      // Present in the link: Read the Frequently Asked Questions 
>>> (FAQ) -
>>> your question may have been answered already.
>>>
>>> FAQ should be mostly targeted towards "users". The same link can be
>>> linked in other places if required.
>>>
>>> OK, Now some topics in the FAQ can be:
>>> ============================================
>>> #
>>> About glusterfs:
>>>
>>> #
>>> Common problems and solutions :
>>>      DHT
>>>
>>>      AFR
>>>
>>>      Quota
>>>
>>>      Snapshotting
>>>
>>>      Geo-replication :
>>>
>>>          #a. While facing geo-rep related issues following output will
>>> help:
>>>              gluster volume geo-replication <Master volume> <Slave
>>> host>::<Slave volume> status
>>>
>>>              gluster volume geo-replication <Master volume> <Slave
>>> host>::<Slave volume> status detail
>>>
>>>          #b. Geo-rep session goes to faulty state:
>>>
>>>              First Check the geo-rep session config file:
>>>              # gluster volume geo-replication <Master volume> <Slave
>>> host>::<Slave volume> config
>>>
>>>              Look for config_file here, and check its contents.
>>>
>>>              In slave nodes, you can check logs in this location:
>>>              /var/log/glusterfs/geo-replication-slaves/
>>>
>>>          #c. Can we have more than one geo-rep session from one master
>>> to multiple slaves?
>>>              Yes. You can have more than one geo-rep session from one
>>> master.
>>>
>>>          #d. What should be the Slave volume configuration? Should it
>>> same as Master volume?
>>>              Slave can have its own Volume configuration different from
>>> Master volume.
>>>          Only requirement is it should be as big as Master volume.
>>>          This is verified while creating geo-rep session itself.
>>>
>>>          #e. Can we have Slave volume different than Gluster type ? For
>>> example, can it be simple .
>>>              NO, This is NOT supported, It should be a gluster 
>>> volume type.
>>>
>>>      gluster NFS , NFS-ganesha
>>>
>>>      Installation issues
>>>
>>> #
>>> Getting Help and Reporting bugs :
>>>
>>>      Having the following information, while posting a query
>>> to gluster-users helps in getting quicker solutions :)
>>>
>>>      gluster --version
>>>      gluster volume info
>>>      gluster volume status
>>>
>>> Logs location:
>>> <update various log location here>
>>>
>>> Looking for existing bugs (OR) trying to post a Bug:
>>> Checkout the bugzilla here:
>>> https://bugzilla.redhat.com/buglist.cgi?classification=Community&list_id=3755093&product=GlusterFS&query_format=advanced 
>>>
>>>
>>>
>>> #
>>> See also :
>>>
>>> Installation Guide:
>>> http://gluster.readthedocs.org/en/latest/Install-Guide/Overview/
>>>
>>> Administration Guide:
>>> http://gluster.readthedocs.org/en/latest/Administrator%20Guide/README/
>>>
>>> Upgrade Guide:
>>> http://gluster.readthedocs.org/en/latest/Upgrade-Guide/README/
>>>
>>> More Documentation:
>>> http://gluster.readthedocs.org/en/latest/
>>> ============================================
>>>
>>> ##
>>> As you can see, I have updated with geo-rep related questions.
>>>
>>> Gluster devels, QAs, and others can collaborate and update this FAQ 
>>> with
>>> their own FAQs. :)
>>>
>>> ##
>>> I think it is NOT necessary that every module needs to have some FAQs,
>>> I just posted it here to get a overview of this.
>>>
>>> Please let me know your suggestions and how to take this further.
>>>
>>
>> Sounds like a good idea to me.
>>
>> Humble, Raghavendra - any suggestions on the repo where we can host 
>> this FAQ?
>>
>>
>
> As discussed in one of the gluster meeting, we can improve or come up 
> with a new doc here in this repo.
>
> https://gluster.readthedocs.org/en/latest/Administrator%20Guide/Troubleshooting/ 
>
>

I think it is better to improve this Troubleshooting guide itself and 
point this Link(as gluster-users-faq) as mentioned above.
This document need not be confined to "Troubleshooting"  alone and have 
general FAQ  (along with other sections )

I will work with Humble on this.

Thanks,
Saravana