Skip to contentSkip to conversation

nvmetcli: More refined cleanup of README

PATCH New Jay Freyensee 3 participants 4 messages Jul 28, 2016 – Aug 1, 2016 NVMe

lore
Share & tools
lore

Jay Freyensee

author
#0 lore raw

PATCH 1/1 nvmetcli: More refined cleanup of README

Adds a few more tidbits to the README file, minus
discovery/referral info (still WIP).

Signed-off-by Jay Freyensee <james_p_freyensee at linux.intel.com>
---
 README | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)
README +13 -1
index 82d63ab..4c3daac 100644
@@ -12,6 +12,11 @@ https://github.com/agrover/configshell-fb first.
 nvmetcli can be run directly from the source directory or installed
 using setup.py.
 
+If you choose to use the provided exe 'nvmetcli', you can move
+'nvmetcli' to /usr/sbin and the file 'nvmet.service' to
+/lib/systemd/system for global management of NVMe target setups
+for the machine.
+
 Common Package Dependencies and Problems
 -----------------------------------------
 nvmetcli uses the 'python-six' and 'pyparsing' packages

@@ -53,6 +58,13 @@ The following walks through an example using interactive mode.
 ...> create hostnqn
 
 #
+# remove access of a subsystem by deleting the Host NQN
+#
+
+...> cd /subsystems/testnqn/allowed_hosts/
+...> delete hostnqn
+
+#
 # Alternatively this allows any host to connect to the subsystsem.  Only
 # use this in tightly controller environments:
 #

@@ -65,7 +77,7 @@ The following walks through an example using interactive mode.
 # unused one will be used.
 #
 
-...> cd namespaces
+...> cd /subsystems/testnqn/namespaces
 ...> create 1
 ...> cd 1
 ...> set device path=/dev/nvme0n1
Signature · 1 line
2.4.3
maintainer
#1 lore raw

PATCH 1/1 nvmetcli: More refined cleanup of README

Looks good,

Reviewed-by Sagi Grimberg <sagi at grimberg.me>
#2 lore raw

PATCH 1/1 nvmetcli: More refined cleanup of README

In reply to Jay Freyensee

README https://github.com/agrover/configshell-fb first. · line 18

Quoted 10 lines · Jay Freyensee
README +4 -0
@@ -12,6 +12,11 @@ https://github.com/agrover/configshell-fb first.
 nvmetcli can be run directly from the source directory or installed
 using setup.py.
 
+If you choose to use the provided exe 'nvmetcli', you can move
+'nvmetcli' to /usr/sbin and the file 'nvmet.service' to
+/lib/systemd/system for global management of NVMe target setups
+for the machine.

Hmm. Maybe we'll need to add a install rule to setup.py instead? Either way the preferred way to install nvmetcli is to use the deb or rpm packaging created by make deb or make rpm. The documentation should point to those as the first choice.

Quoted 18 lines
README +7 -0
 Common Package Dependencies and Problems
 -----------------------------------------
 nvmetcli uses the 'python-six' and 'pyparsing' packages

@@ -53,6 +58,13 @@ The following walks through an example using interactive mode.
 ...> create hostnqn
 
 #
+# remove access of a subsystem by deleting the Host NQN
+#
+
+...> cd /subsystems/testnqn/allowed_hosts/
+...> delete hostnqn
+
+#
 # Alternatively this allows any host to connect to the subsystsem.  Only
 # use this in tightly controller environments:
 #

README The following walks through an example using interactive mode. · line 83

Quoted 8 lines
README +1 -1
@@ -65,7 +77,7 @@ The following walks through an example using interactive mode.
 # unused one will be used.
 #
 
-...> cd namespaces
+...> cd /subsystems/testnqn/namespaces
 ...> create 1
 ...> cd 1
 ...> set device path=/dev/nvme0n1

But I've applied this part already and pushed it out.

author
#3 lore raw

PATCH 1/1 nvmetcli: More refined cleanup of README

Quoted 8 lines · Christoph Hellwig
Quoted 7 lines · Jay Freyensee
README +0 -0
@@ -12,6 +12,11 @@ https://github.com/agrover/configshell-fb first.
 nvmetcli can be run directly from the source directory or

installed
using setup.py.

Quoted 9 lines

README https://github.com/agrover/configshell-fb first. · line 18

Quoted 4 lines
README +4 -0
+If you choose to use the provided exe 'nvmetcli', you can move
+'nvmetcli' to /usr/sbin and the file 'nvmet.service' to
+/lib/systemd/system for global management of NVMe target setups
+for the machine.

Hmm. Maybe we'll need to add a install rule to setup.py instead? Either way the preferred way to install nvmetcli is to use the deb or rpm packaging created by make deb or make rpm. The documentation should point to those as the first choice.

That would probably work too.

I can say .deb/.rpm is preferrred, but from my previous experience, .rpm doesn't always work, hence the background info.

Quoted 25 lines
Quoted 25 lines

Common Package Dependencies and Problems
-----------------------------------------
nvmetcli uses the 'python-six' and 'pyparsing' packages

README +0 -0
@@ -53,6 +58,13 @@ The following walks through an example using

interactive mode.
...> create hostnqn

#

README +7 -0
+# remove access of a subsystem by deleting the Host NQN
+#
+
+...> cd /subsystems/testnqn/allowed_hosts/
+...> delete hostnqn
+
+#
 # Alternatively this allows any host to connect to the subsystsem.
  Only
 # use this in tightly controller environments:
 #

@@ -65,7 +77,7 @@ The following walks through an example using

interactive mode.

 # unused one will be used.
 #
Quoted 7 lines
Quoted 5 lines

-...> cd namespaces
+...> cd /subsystems/testnqn/namespaces
...> create 1
...> cd 1
...> set device path=/dev/nvme0n1

But I've applied this part already and pushed it out.

OK. I'll add another blurb on discovery and referrals, hopefully soon.

Quoted 5 lines

_______________________________________________
Linux-nvme mailing list
Linux-nvme at lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-nvme