| Summary: | use timeout option in CLI for time consuming commands | ||
|---|---|---|---|
| Product: | Red Hat Gluster Storage | Reporter: | Atin Mukherjee <amukherj> |
| Component: | doc-Administration_Guide | Assignee: | Divya <divya> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Prasad Desala <tdesala> |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | rhgs-3.2 | CC: | amukherj, asriram, divya, rcyriac, rhinduja, rhs-bugs, rwheeler, sankarshan, storage-doc, storage-qa-internal |
| Target Milestone: | --- | ||
| Target Release: | RHGS 3.2.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-03-24 10:23:16 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: | |
| Bug Depends On: | |||
| Bug Blocks: | 1351553 | ||
|
Description
Atin Mukherjee
2016-11-21 05:45:52 UTC
Atin, I have documented the --time-out option based on the bug description. Link to the doc: http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.2-Administration_Guide-branch-BZ-1396890-add_timeout_option/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html#Displaying_Volume_Status Please review and let me know if it requires any other change. Thanks! Few corrections required: The first sentence is formed up as "When you try to obtain information about the inode or clients or details, they may get timed out if the glusterd takes longer than 120 seconds, the default timeout, to process these commands". Instead of that can we reword it as "When you try to obtain information about inodes or clients or details of a specific volume, the command may get timed out from CLI if the originator GlusterD taken longer than 120 seconds, the default time out, to aggregate the results from all the other GlusterDs and report back to CLI". Secondly the immediate statement provides a sort of indication that the --timeout option *only* works with volume status inode/clients/details which is not the case. It can work with any CLI, its just we are highlighting the commands which are more susceptible to time out given the heavy data exchange between the CLI & GlusterD. We have to be clear on this part. (In reply to Atin Mukherjee from comment #3) Atin, I have updated the documentation based on the feedback in Comment 3. Link to the latest doc: http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.2-Administration_Guide-branch-BZ-1396890-add_timeout_option/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html#Displaying_Volume_Status I have also added "timeout" option to the volume status command. Could you please check and let me know if the changes are fine? Looks good. Documented --timeout option in the "19.9. Displaying Volume Status" section. Link to the doc: http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.2-Administration_Guide-branch-master/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html#Displaying_Volume_Status Verified the doc provided in Comment 6. The content looks good but requires below two minor changes, Section: 19.9. Displaying Volume Status 1) "It is receommended to use --time-out option when obtaining information about the inodes or clients or details as they frequently get timed out." >> typo error in the word "recommended" 2) Spacing issues in "gluster volume status test-volume" and "gluster volume status all" outputs. (In reply to Prasad Desala from comment #7) I have fixed the issues listed in Comment 7. Link to the latest doc: http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.2-Administration_Guide-branch-master/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html#Displaying_Volume_Status Moving the bug ON_QA. Looks good. RHGS 3.2.0 GA completed on 23 March 2017 |