Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update cstor volume describe replica details heading to accurately specifiy underlying properties in an easy-to-grok way #135

Closed
vharsh opened this issue Nov 25, 2021 · 0 comments · Fixed by #137
Assignees
Labels
bug Something isn't working community enhancement New feature or request invalid This doesn't seem right question Further information is requested refactor

Comments

@vharsh
Copy link
Member

vharsh commented Nov 25, 2021

The term Total and Free aren't super indicative of the spaces used by actual data or snapshots or metadata or at the application level and it does pop eyeballs when Total < Free.

The Output

root@test-pcl4004:~# kubectl openebs describe volume pvc-7d5944e9-XXXXXXXXXXXX

pvc-7d5944e9-XXXXXXXXXXXX Details :
-----------------
NAME            : XXXXX
ACCESS MODE     : ReadWriteOnce
CSI DRIVER      : cstor.csi.openebs.io
STORAGE CLASS   : XXXX
VOLUME PHASE    : Bound
VERSION         : 2.10.0
CSPC            : XXXXXXXX
SIZE            : 2.0GiB
STATUS          : Healthy
REPLICA COUNT   : 1

Portal Details :
------------------
IQN              :  iqn.2016-09.com.openebs.cstor:XXXX
VOLUME NAME      :  XXXX
TARGET NODE NAME :  ABCD
PORTAL           :  XXXXX:3260
TARGET IP        :  XXXXX

Replica Details :
-----------------
NAME                                                            TOTAL     USED       STATUS    AGE
XXXXXXXXXXXXXXXXXXXXXXXXXSDJHFSHGHGHXXXXXXXXXXXXXXX-YYYYYYYZZZ   33.6MiB   126.8MiB   Healthy   67d1h

In the above output example, with the above headings it sort of becomes imperative that, Total = Free + Used, so in practice Used shouldn't exceed Total(unless Free is negative, which is absurd), but here the above values total means actual data written to disk & used means how much data got referenced.

At the nuts and bolts level, TOTAL comes from cvr.spec.capacity.Total which is USED property at the zfs level and used comes from cvr.spec.capacity.Used which is the logicalreferenced property at the zfs level.

Tl; dr: What needs to be done?

  1. The underlying ZFS metric needs to be understood well enough(this isn't super straightforward)
  2. The understanding of the above metric should be conveyed properly via simple English phrases/words, such as space used by data with compression, metadata, etc or something simple such as actual size on disk, logical size written by tenants, etc.
@vharsh vharsh added bug Something isn't working enhancement New feature or request invalid This doesn't seem right question Further information is requested refactor community labels Nov 25, 2021
@vharsh vharsh self-assigned this Jan 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working community enhancement New feature or request invalid This doesn't seem right question Further information is requested refactor
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant