aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoryuryalekseev <yuryalekseev@yandex-team.com>2023-02-18 15:43:07 +0300
committeryuryalekseev <yuryalekseev@yandex-team.com>2023-02-18 15:43:07 +0300
commit80b3082f385c500477b1cae56b369904ec00d5eb (patch)
tree61ac9f3e5c3b28486efaaca8ac3a5927f11c9357
parent32e9a06cb4641872dac807017e54e2a32b848222 (diff)
downloadydb-80b3082f385c500477b1cae56b369904ec00d5eb.tar.gz
Add device list to ydb-dstool README.md.
-rw-r--r--ydb/apps/dstool/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/ydb/apps/dstool/README.md b/ydb/apps/dstool/README.md
index 200b91d7e5..ff83edda3a 100644
--- a/ydb/apps/dstool/README.md
+++ b/ydb/apps/dstool/README.md
@@ -211,8 +211,30 @@ or ```-H``` to command options:
user@host:~$ ydb-dstool -e ydbd.endpoint pdisk list --show-pdisk-usage -H
```
+## Do things with storage devices
+
+A storage device is a hardware data storage installed on one of the cluster's machines and prepared for cluster's use.
+Currently the following types of storage devices are supported:
+
+* HDD
+* SSD
+* NVME
+
+A storage device available on a cluster and preperated for use, may or may not be used by the cluster.
+
+### List devices
+
+```bash
+user@host:~$ ydb-dstool -e ydbd.endpoint device list
+```
+
+The above command lists all storage devices of a cluster available for use.
+
## Do things with pdisks
+Physical disk or pdisk is an abstraction of a storage device which is used by the cluster. As a result every pdisk
+has an associated storage device, but not every storage device has an associated pdisk.
+
### List pdisks
```bash