qsd: Document fuse's allow-other option
PATCH 1/1 qsd: Document fuse's allow-other option
We did not add documentation to the storage daemon's man page for fuse's allow-other option when it was introduced, so do that now.
--- docs/tools/qemu-storage-daemon.rst | 9 +++++++-- storage-daemon/qemu-storage-daemon.c | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-)
docs/tools/qemu-storage-daemon.rst +7 -2
@@ -76,7 +76,7 @@ Standard options: .. option:: --export [type=]nbd,id=<id>,node-name=<node-name>[,name=<export-name>][,writable=on|off][,bitmap=<name>] --export [type=]vhost-user-blk,id=<id>,node-name=<node-name>,addr.type=unix,addr.path=<socket-path>[,writable=on|off][,logical-block-size=<block-size>][,num-queues=<num-queues>] --export [type=]vhost-user-blk,id=<id>,node-name=<node-name>,addr.type=fd,addr.str=<fd>[,writable=on|off][,logical-block-size=<block-size>][,num-queues=<num-queues>] - --export [type=]fuse,id=<id>,node-name=<node-name>,mountpoint=<file>[,growable=on|off][,writable=on|off] + --export [type=]fuse,id=<id>,node-name=<node-name>,mountpoint=<file>[,growable=on|off][,writable=on|off][,allow-other=on|off|auto] is a block export definition. ``node-name`` is the block node that should be exported. ``writable`` determines whether or not the export allows write
@@ -103,7 +103,12 @@ Standard options: mounted). Consequently, applications that have opened the given file before the export became active will continue to see its original content. If ``growable`` is set, writes after the end of the exported file will grow the - block node to fit. + block node to fit. The ``allow-other`` option controls whether users other + than the QSD user will be allowed to access the export. Note that enabling + this option as a non-root user requires enabling the user_allow_other option + in the global fuse.conf configuration file. Setting ``allow-other`` to auto + (the default) will have the QSD try enabling this option, and on error fall + back to disabling it. .. option:: --monitor MONITORDEF
storage-daemon/qemu-storage-daemon.c +1 -1
@@ -100,7 +100,7 @@ static void help(void) "\n"#ifdef CONFIG_FUSE " --export [type=]fuse,id=<id>,node-name=<node-name>,mountpoint=<file>\n" -" [,growable=on|off][,writable=on|off]\n" +" [,growable=on|off][,writable=on|off][,allow-other=on|off|auto]\n" " export the specified block node over FUSE\n" "\n"#endif /* CONFIG_FUSE */
Signature · 1 line
2.34.1
Am 24.01.2022 um 18:03 hat Hanna Reitz geschrieben:
Quoted 24 lines
We did not add documentation to the storage daemon's man page for fuse's allow-other option when it was introduced, so do that now.
Fixes 8fc54f9428b9763f800 ("export/fuse: Add allow-other option")Signed-off-by Hanna Reitz <[email protected]>--- docs/tools/qemu-storage-daemon.rst | 9 +++++++-- storage-daemon/qemu-storage-daemon.c | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-)docs/tools/qemu-storage-daemon.rst +1
-1@@ -76,7 +76,7 @@ Standard options: .. option:: --export [type=]nbd,id=<id>,node-name=<node-name>[,name=<export-name>][,writable=on|off][,bitmap=<name>] --export [type=]vhost-user-blk,id=<id>,node-name=<node-name>,addr.type=unix,addr.path=<socket-path>[,writable=on|off][,logical-block-size=<block-size>][,num-queues=<num-queues>] --export [type=]vhost-user-blk,id=<id>,node-name=<node-name>,addr.type=fd,addr.str=<fd>[,writable=on|off][,logical-block-size=<block-size>][,num-queues=<num-queues>] - --export [type=]fuse,id=<id>,node-name=<node-name>,mountpoint=<file>[,growable=on|off][,writable=on|off] + --export [type=]fuse,id=<id>,node-name=<node-name>,mountpoint=<file>[,growable=on|off][,writable=on|off][,allow-other=on|off|auto] is a block export definition. ``node-name`` is the block node that should be exported. ``writable`` determines whether or not the export allows write
docs/tools/qemu-storage-daemon.rst Standard options: · line 111
Quoted 10 lines
docs/tools/qemu-storage-daemon.rst +6
-1@@ -103,7 +103,12 @@ Standard options: mounted). Consequently, applications that have opened the given file before the export became active will continue to see its original content. If ``growable`` is set, writes after the end of the exported file will grow the - block node to fit. + block node to fit. The ``allow-other`` option controls whether users other + than the QSD user will be allowed to access the export. Note that enabling + this option as a non-root user requires enabling the user_allow_other option + in the global fuse.conf configuration file. Setting ``allow-other`` to auto + (the default) will have the QSD try enabling this option, and on error fall + back to disabling it.
"QSD" is not an acronym that is used (or introduced) elsewhere in this document.
I suggest replacing "QSD user" with "user running the process" and "will have the QSD try" with simply "will try".
Quoted 7 lines
docs/tools/qemu-storage-daemon.rst +0
-0.. option:: --monitor MONITORDEFstorage-daemon/qemu-storage-daemon.c +0
-0
storage-daemon/qemu-storage-daemon.c static void help(void) · line 106
Quoted 8 lines
storage-daemon/qemu-storage-daemon.c +1
-1@@ -100,7 +100,7 @@ static void help(void) "\n"#ifdef CONFIG_FUSE " --export [type=]fuse,id=<id>,node-name=<node-name>,mountpoint=<file>\n" -" [,growable=on|off][,writable=on|off]\n" +" [,growable=on|off][,writable=on|off][,allow-other=on|off|auto]\n" " export the specified block node over FUSE\n" "\n"#endif /* CONFIG_FUSE */
Looks good otherwise.
Kevin
Quoted 22 lines · Kevin Wolf
Am 24.01.2022 um 18:03 hat Hanna Reitz geschrieben:
Quoted 21 lines
We did not add documentation to the storage daemon's man page for fuse's allow-other option when it was introduced, so do that now.
Fixes 8fc54f9428b9763f800 ("export/fuse: Add allow-other option")Signed-off-by Hanna Reitz <[email protected]>--- docs/tools/qemu-storage-daemon.rst | 9 +++++++-- storage-daemon/qemu-storage-daemon.c | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-)docs/tools/qemu-storage-daemon.rst +1
-1@@ -76,7 +76,7 @@ Standard options: .. option:: --export [type=]nbd,id=<id>,node-name=<node-name>[,name=<export-name>][,writable=on|off][,bitmap=<name>] --export [type=]vhost-user-blk,id=<id>,node-name=<node-name>,addr.type=unix,addr.path=<socket-path>[,writable=on|off][,logical-block-size=<block-size>][,num-queues=<num-queues>] --export [type=]vhost-user-blk,id=<id>,node-name=<node-name>,addr.type=fd,addr.str=<fd>[,writable=on|off][,logical-block-size=<block-size>][,num-queues=<num-queues>] - --export [type=]fuse,id=<id>,node-name=<node-name>,mountpoint=<file>[,growable=on|off][,writable=on|off] + --export [type=]fuse,id=<id>,node-name=<node-name>,mountpoint=<file>[,growable=on|off][,writable=on|off][,allow-other=on|off|auto]
Quoted 15 lines
docs/tools/qemu-storage-daemon.rst Standard options: · line 111
Quoted 13 lines
docs/tools/qemu-storage-daemon.rst +6
-1is a block export definition. ``node-name`` is the block node that should be exported. ``writable`` determines whether or not the export allows write@@ -103,7 +103,12 @@ Standard options: mounted). Consequently, applications that have opened the given file before the export became active will continue to see its original content. If ``growable`` is set, writes after the end of the exported file will grow the - block node to fit. + block node to fit. The ``allow-other`` option controls whether users other + than the QSD user will be allowed to access the export. Note that enabling + this option as a non-root user requires enabling the user_allow_other option + in the global fuse.conf configuration file. Setting ``allow-other`` to auto + (the default) will have the QSD try enabling this option, and on error fall + back to disabling it."QSD" is not an acronym that is used (or introduced) elsewhere in this document.
It’s used in “qsd-qmp.sock”, “qsd-nbd.sock”, and “qsd.pid” O:)
Quoted 2 lines
I suggest replacing "QSD user" with "user running the process" and "will have the QSD try" with simply "will try".
Sure, sounds good, will do!
Hanna
Quoted 19 lines
Quoted 7 lines
docs/tools/qemu-storage-daemon.rst +0
-0.. option:: --monitor MONITORDEFstorage-daemon/qemu-storage-daemon.c +0
-0storage-daemon/qemu-storage-daemon.c static void help(void) · line 106
Quoted 8 lines
storage-daemon/qemu-storage-daemon.c +1
-1@@ -100,7 +100,7 @@ static void help(void) "\n"#ifdef CONFIG_FUSE " --export [type=]fuse,id=<id>,node-name=<node-name>,mountpoint=<file>\n" -" [,growable=on|off][,writable=on|off]\n" +" [,growable=on|off][,writable=on|off][,allow-other=on|off|auto]\n" " export the specified block node over FUSE\n" "\n"#endif /* CONFIG_FUSE */ Looks good otherwise.
Kevin