Bug 1667783 - [Doc][Admin] Documentation expected for "Warning Low Confirmed Space Indicator"
Summary: [Doc][Admin] Documentation expected for "Warning Low Confirmed Space Indicator"
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 4.2.7
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ovirt-4.4.6
: ---
Assignee: Steve Goodman
QA Contact: SATHEESARAN
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-01-21 04:53 UTC by Abhishekh Patil
Modified: 2021-06-07 13:56 UTC (History)
11 users (show)

Fixed In Version:
Doc Type: No Doc Update
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-06-07 13:56:58 UTC
oVirt Team: Gluster
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
Manage Storage Domain Dialog Box (105.81 KB, image/png)
2021-03-03 08:22 UTC, Eyal Shenitzky
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Red Hat Knowledge Base (Solution) 3881961 0 None None None 2019-08-21 17:07:21 UTC

Description Abhishekh Patil 2019-01-21 04:53:24 UTC
Description of problem:

Documentation for "Warning Low Confirmed Space Indicator" is missing in the administration guide. 

Below is the reason why above parameter is introduced:

Monitoring of gluster bricks/volumes takes into consideration the thinpool and vdo devices that are configured for a brick directory and reports the guaranteed available space as seen by brick/volume
An alert should be raised when this guaranteed capacity drops below 80/90 % of total available space. The threshold at which alerted should be configurable. 


With VDO and Thin pool support, users may see more space, that it is available physically. This is totally fine and with VDO it is an expected behavior. At the same time, we can't predict, how much data user will be able to actually write. Because of that, to keep user informed, we would like to notify him, when he is running out of physical space and, at the same time, show him how much confirmed space he have.

Comment 2 Steve Goodman 2020-10-21 14:40:14 UTC
We currently don't have an explanation of any parameters in the Manage Domain dialog. If we did, I would just add this parameter.

So what is the user story here? What is the user's motivation? What is the user trying to do? (i.e. What is the task that we were documenting?)

The knowledgebase article just explains what the parameter means.

Comment 3 Marina Kalinin 2021-01-12 01:19:31 UTC
(In reply to Steve Goodman from comment #2)
> We currently don't have an explanation of any parameters in the Manage
> Domain dialog. If we did, I would just add this parameter.
> 
> So what is the user story here? What is the user's motivation? What is the
> user trying to do? (i.e. What is the task that we were documenting?)
> 
> The knowledgebase article just explains what the parameter means.

Can't you just put it somewhere, where other parameters are described, under storage section explanation?
User story can be as simple as - what does this parameter means? I do not understand how it impacts my environment and why it matters.

Comment 4 Marina Kalinin 2021-03-02 14:21:26 UTC
Eyal,

There should be config parameter name for this threshold. Can you please help docs team to identify it, so they can put it in the storage section in a table - config name on one side, UX name on another. So if anyone is looking for it, also understands where to adjust it.

Thank you.

Comment 5 Eyal Shenitzky 2021-03-03 08:22:20 UTC
Created attachment 1760360 [details]
Manage Storage Domain Dialog Box

Comment 6 Eyal Shenitzky 2021-03-03 08:22:47 UTC
The way to configure it is per storage domain.
It can be done via the UI or REST-API.

I added a screenshot for the relevant dialog box.

Comment 7 Steve Goodman 2021-05-13 14:55:59 UTC
Marina and I just chatted. Amazing how quickly you can decide on what to do after a 15 minute face to face conversation.

Here's what we need to do:

Add a new module named "Monitoring available/low space in a storage domain" somewhere in 11.8 in the Admin Guide (Storage Tasks).

Here's a quick draft of the content for the new module:

----
You can monitor available space in a storage domain and create an alert to warn you when a storage domain is nearing capacity. You can also define a critical threshold at which point the domain shuts down.

With VDO and Thin pool support, you might see more available space than is physically available. For VDO this behavior is expected. However, the {engine-name} cannot predict how much data you can actually write. This parameter notifies you when the domain is nearing physical space capacity and shows how much confirmed space remains.

???It's not clear what is physical space and what is "confirmed" space.???

.Procedure

. In the Administration Portal, Click *Storage>Storage Domain*>the name of a storage domain.
. Click *Manage Domain*.
. Expand *Advanced Parameters*.
. For *Warning Low Space Indicator (%)* enter a percent value. When the available space in the storage domain reaches this value, the {engine-name} alerts you that the domain is nearing capacity.
. For *Critical Space Action Blocker (GB), enter a GB value. When the available space in the storage domain reaches this value, the {engine-name} shuts down.
. For *Warning Low Confirmed Space Indicator (%)* enter a percent value. When the available space in the storage domain reaches this value, the {engine-name} alerts you that...???
----

Comment 8 Steve Goodman 2021-05-16 05:38:22 UTC
Merge request:

https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_Enterprise_Virtualization/-/merge_requests/1977

Eyal, I have some questions in the merge request. Please review.

Comment 9 Eyal Shenitzky 2021-05-23 11:23:12 UTC
Hi Steve, I couldn't find any questions in the merge request.
Can you post them here?

Comment 10 Steve Goodman 2021-05-24 11:50:10 UTC
(In reply to Eyal Shenitzky from comment #9)
> Hi Steve, I couldn't find any questions in the merge request.
> Can you post them here?


First of all, I need you to review the text I wrote. Within that text there are two places that I was not sure what to put. I indicated those points with "???". You can also see those question in comment 7.

Comment 11 Eyal Shenitzky 2021-05-25 11:14:04 UTC
???It's not clear what is physical space and what is "confirmed" space.??? 

From bug 1568893, I see that confirmed space is - the thinpool and vdo devices that are configured for a brick directory and reports the guaranteed available space as seen by brick/volume.

Also, this feature was added for the Gluster team so I am moving it for Gluster to add more info.

Comment 12 Steve Goodman 2021-05-25 13:13:11 UTC
Meital, Who should do QA on this?

Comment 13 Steve Goodman 2021-05-27 11:41:14 UTC
Abhishekh, can you answer the questions in comment 7, indicated by "???"?

And can you review the merge request: https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_Enterprise_Virtualization/-/merge_requests/1977

If you aren't able to help, can you refer me to someone on the Gluster team who can?

Comment 14 Abhishekh Patil 2021-06-02 00:52:46 UTC
(In reply to Steve Goodman from comment #13)
> Abhishekh, can you answer the questions in comment 7, indicated by "???"?
> 
> And can you review the merge request:
> https://gitlab.cee.redhat.com/rhci-documentation/docs-
> Red_Hat_Enterprise_Virtualization/-/merge_requests/1977
> 
> If you aren't able to help, can you refer me to someone on the Gluster team
> who can?

I think 'physical space' is the available space user observes from RHV side and 'confirmed space' notifies how much data user can actually write. With VDO and Thin pool support, users may see more space, that it is available physically at storage end. So, confirmed space will let users know how much actual space is available to write the data.

Comment 15 Steve Goodman 2021-06-02 09:03:25 UTC
Thanks!

Can you please confirm that the MR is now correct and complete? 

https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_Enterprise_Virtualization/-/merge_requests/1977/diffs

Comment 16 Abhishekh Patil 2021-06-02 09:13:15 UTC
(In reply to Steve Goodman from comment #15)
> Thanks!
> 
> Can you please confirm that the MR is now correct and complete? 
> 
> https://gitlab.cee.redhat.com/rhci-documentation/docs-
> Red_Hat_Enterprise_Virtualization/-/merge_requests/1977/diffs

It looks good, we needed that in the documentation. Thanks a lot!

Comment 17 Steve Goodman 2021-06-02 10:15:38 UTC
Satheesaran,

Please verify that this procedure is correctly documented, and add any comments you might have.

See the merge request at:
https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_Enterprise_Virtualization/-/merge_requests/1977

Preview is here:
https://cee-jenkins.rhev-ci-vms.eng.rdu2.redhat.com/job/CCS/job/ccs-mr-preview/37704/artifact/doc-Administration_Guide/preview/index.html#monitoring-available-space-in-a-storage-domain_storage_tasks

If the preview doesn't exist anymore, enter "rebuild" as a comment in the MR.

Comment 18 SATHEESARAN 2021-06-03 11:03:39 UTC
(In reply to Steve Goodman from comment #17)
> Satheesaran,
> 
> Please verify that this procedure is correctly documented, and add any
> comments you might have.
> 
> See the merge request at:
> https://gitlab.cee.redhat.com/rhci-documentation/docs-
> Red_Hat_Enterprise_Virtualization/-/merge_requests/1977
> 
> Preview is here:
> https://cee-jenkins.rhev-ci-vms.eng.rdu2.redhat.com/job/CCS/job/ccs-mr-
> preview/37704/artifact/doc-Administration_Guide/preview/index.
> html#monitoring-available-space-in-a-storage-domain_storage_tasks
> 
> If the preview doesn't exist anymore, enter "rebuild" as a comment in the MR.

Thanks Steve. The content looks good.

Comment 19 Donna DaCosta 2021-06-03 14:38:22 UTC
Peer review completed and my comments are in the merge request.

Comment 20 Steve Goodman 2021-06-06 13:28:37 UTC
Merged

Comment 21 Steve Goodman 2021-06-07 13:56:58 UTC
Pantheon is having issues with publishing, but this will be published when the bug is worked out.

So I'm marking this as CLOSED.


Note You need to log in before you can comment on or make changes to this bug.