From b2238ee7100cac3c03d100b39a1ad53e995f16f9 Mon Sep 17 00:00:00 2001 From: Abrar Basha Date: Tue, 14 Feb 2023 09:14:41 -0500 Subject: [PATCH 1/5] dellctl volume list update for release 1.5.1 --- content/docs/references/cli/_index.md | 29 ++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/content/docs/references/cli/_index.md b/content/docs/references/cli/_index.md index 79121293f1..5a0e0007ff 100644 --- a/content/docs/references/cli/_index.md +++ b/content/docs/references/cli/_index.md @@ -30,10 +30,11 @@ This document outlines all dellctl commands, their intended use, options that ca | [dellctl schedule get](#dellctl-schedule-get) | Get schedules | | [dellctl encryption rekey](#dellctl-encryption-rekey) | Rekey an encrypted volume | | [dellctl encryption rekey-status](#dellctl-encryption-rekey-status) | Get status of an encryption rekey operation | +| [dellctl volume list](#dellctl-volume-list) | Lists metadata for local volumes on cluster | ## Installation instructions -1. Download `dellctl` from [here](https://github.com/dell/csm/releases/tag/v1.4.0). +1. Download `dellctl` from [here](https://github.com/dell/csm/releases/tag/v1.5.1). 2. chmod +x dellctl 3. Move `dellctl` to `/usr/local/bin` or add `dellctl`'s containing directory path to PATH environment variable. 4. Run `dellctl --help` to know available commands or run `dellctl command --help` to know more about a specific command. @@ -782,3 +783,29 @@ Encryption rekey status with name of the rekey object # dellctl encryption rekey-status myrekey INFO Status of rekey request myrekey = completed ``` +### dellctl volume list + +Lists metadata for local volumes on cluster + +##### Flags + +``` + --cluster-id string Id of the cluster managed by dellctl + -h, --help help for list + --insecure string TLS transaction to use InsecureSkipVerify + --namespace string driver namespace to use + --proxy string auth proxy endpoint to use +``` + +##### Output + +Retrieve volume list metadata filtered on proxy, insecure, and namespace designations + +``` +# dellctl volume list --proxy https://lglap124.hop.lab.emc.com/proxy/volumes --insecure true --namespace vxflexos +NAME VOLUME ID SIZE POOL SYSTEM ID PV NAME PV STATUS STORAGE CLASS PVC NAME NAMESPACE +k8s-0325497cd7 a69b554f00000004 8.000000 mypool 636468e3638c840f k8s-0325497cd7 released vxflexos vol-create-test-cthdf replication-suite-fe2eac41 +k8s-a0c031582b a69b555000000005 8.000000 mypool 636468e3638c840f k8s-a0c031582b released vxflexos vol-create-test-nqfwz replication-suite-fe2eac41 +k8s-3908a6954f a69b555100000006 8.000000 mypool 636468e3638c840f k8s-3908a6954f released vxflexos vol-create-test-4flg5 replication-suite-fe2eac41 +k8s-28e4184f41 a69b554e00000003 8.000000 mypool 636468e3638c840f k8s-28e4184f41 released vxflexos vol-create-test-nnvxf replication-suite-fe2eac41 +``` From 2ab640b19c55369bfa263312902339a24f690283 Mon Sep 17 00:00:00 2001 From: Abrar Basha Date: Tue, 14 Feb 2023 14:54:16 -0500 Subject: [PATCH 2/5] fixed volume list description and adjusted output to be clearer --- content/docs/references/cli/_index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/docs/references/cli/_index.md b/content/docs/references/cli/_index.md index 5a0e0007ff..5ac3f2607b 100644 --- a/content/docs/references/cli/_index.md +++ b/content/docs/references/cli/_index.md @@ -785,7 +785,7 @@ Encryption rekey status with name of the rekey object ``` ### dellctl volume list -Lists metadata for local volumes on cluster +Lists local volumes metadata for a given tenant. ##### Flags @@ -793,19 +793,19 @@ Lists metadata for local volumes on cluster --cluster-id string Id of the cluster managed by dellctl -h, --help help for list --insecure string TLS transaction to use InsecureSkipVerify - --namespace string driver namespace to use + --namespace string namespace of the secret for the given tenant --proxy string auth proxy endpoint to use ``` ##### Output -Retrieve volume list metadata filtered on proxy, insecure, and namespace designations +Retrieve volume list metadata for a given tenant. The namespace is used to designate where the tenant has given it's secret token. ``` -# dellctl volume list --proxy https://lglap124.hop.lab.emc.com/proxy/volumes --insecure true --namespace vxflexos +# dellctl volume list --proxy --namespace vxflexos NAME VOLUME ID SIZE POOL SYSTEM ID PV NAME PV STATUS STORAGE CLASS PVC NAME NAMESPACE k8s-0325497cd7 a69b554f00000004 8.000000 mypool 636468e3638c840f k8s-0325497cd7 released vxflexos vol-create-test-cthdf replication-suite-fe2eac41 k8s-a0c031582b a69b555000000005 8.000000 mypool 636468e3638c840f k8s-a0c031582b released vxflexos vol-create-test-nqfwz replication-suite-fe2eac41 k8s-3908a6954f a69b555100000006 8.000000 mypool 636468e3638c840f k8s-3908a6954f released vxflexos vol-create-test-4flg5 replication-suite-fe2eac41 -k8s-28e4184f41 a69b554e00000003 8.000000 mypool 636468e3638c840f k8s-28e4184f41 released vxflexos vol-create-test-nnvxf replication-suite-fe2eac41 +k8s-28e4184f41 a69b554e00000003 8.000000 mypool 636468e3638c840f none none none none none ``` From 216b760865008bb0217029c2f48f2ce193846a67 Mon Sep 17 00:00:00 2001 From: Abrar Basha Date: Tue, 14 Feb 2023 17:14:38 -0500 Subject: [PATCH 3/5] updated output description --- content/docs/references/cli/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/references/cli/_index.md b/content/docs/references/cli/_index.md index 5ac3f2607b..d5461f8a55 100644 --- a/content/docs/references/cli/_index.md +++ b/content/docs/references/cli/_index.md @@ -799,7 +799,7 @@ Lists local volumes metadata for a given tenant. ##### Output -Retrieve volume list metadata for a given tenant. The namespace is used to designate where the tenant has given it's secret token. +Retrieve volume list metadata for a given tenant. The namespace is the namespace where tenant secret is created. ``` # dellctl volume list --proxy --namespace vxflexos From 4fa4ad22c8acd26030dd2d15988c9eb2923e8fdf Mon Sep 17 00:00:00 2001 From: Abrar Basha Date: Tue, 14 Feb 2023 17:20:13 -0500 Subject: [PATCH 4/5] updated general dellctl volume list description --- content/docs/references/cli/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/references/cli/_index.md b/content/docs/references/cli/_index.md index d5461f8a55..355e9a9840 100644 --- a/content/docs/references/cli/_index.md +++ b/content/docs/references/cli/_index.md @@ -30,7 +30,7 @@ This document outlines all dellctl commands, their intended use, options that ca | [dellctl schedule get](#dellctl-schedule-get) | Get schedules | | [dellctl encryption rekey](#dellctl-encryption-rekey) | Rekey an encrypted volume | | [dellctl encryption rekey-status](#dellctl-encryption-rekey-status) | Get status of an encryption rekey operation | -| [dellctl volume list](#dellctl-volume-list) | Lists metadata for local volumes on cluster | +| [dellctl volume list](#dellctl-volume-list) | Lists local volumes metadata for a given tenant | ## Installation instructions From febf8a3c05e43743e92b5fc79bd9cecee042bdb0 Mon Sep 17 00:00:00 2001 From: Abrar Basha Date: Wed, 15 Feb 2023 09:22:25 -0500 Subject: [PATCH 5/5] specified volume list command is for PowerFlex volumes only --- content/docs/references/cli/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/references/cli/_index.md b/content/docs/references/cli/_index.md index 355e9a9840..369e008f76 100644 --- a/content/docs/references/cli/_index.md +++ b/content/docs/references/cli/_index.md @@ -785,7 +785,7 @@ Encryption rekey status with name of the rekey object ``` ### dellctl volume list -Lists local volumes metadata for a given tenant. +Lists metadata on local PowerFlex volumes for a given tenant. ##### Flags