[libvirt PATCHv4 05/15] docs: add virtiofs kbase

[Ján Tomko]

[adding dgilbert]

On Wed, Feb 26, 2020 at 10:28:18AM +0100, Peter Krempa wrote:
>On Thu, Feb 20, 2020 at 15:32:42 +0100, Ján Tomko wrote:
>> Add a document describing the usage of virtiofs.
>> ---
>>  docs/kbase.html.in      |   3 +
>>  docs/kbase/virtiofs.rst | 152 ++++++++++++++++++++++++++++++++++++++++
>>  2 files changed, 155 insertions(+)
>>  create mode 100644 docs/kbase/virtiofs.rst
>>
>> diff --git a/docs/kbase.html.in b/docs/kbase.html.in
>> index c156414c41..7d6caf3cb1 100644
>> --- a/docs/kbase.html.in
>> +++ b/docs/kbase.html.in
>> @@ -29,6 +29,9 @@
>>          <dt><a href="kbase/backing_chains.html">Backing chain management</a></dt>
>>          <dd>Explanation of how disk backing chain specification impacts libvirt's
>>            behaviour and basic troubleshooting steps of disk problems.</dd>
>> +
>> +        <dt><a href="kbase/virtiofs.html">Virtio-FS</a></dt>
>> +        <dd>Share a filesystem between the guest and the host</dd>
>>        </dl>
>>      </div>
>>
>> diff --git a/docs/kbase/virtiofs.rst b/docs/kbase/virtiofs.rst
>> new file mode 100644
>> index 0000000000..fe6885d139
>> --- /dev/null
>> +++ b/docs/kbase/virtiofs.rst
>> @@ -0,0 +1,152 @@
>> +============================
>> +Sharing files with Virtio-FS
>> +============================
>> +
>> +=== 8< delete before merging 8< ===
>> +NOTE: if you're looking at this note, this is just a proposal.
>> +See the up-to-date version on: https://libvirt.org/kbase/virtiofs.html
>> +=== 8< --------------------- 8< ===
>> +
>> +.. contents::
>> +
>> +=========
>> +Virtio-FS
>> +=========
>> +
>> +Virtio-FS is a shared file system that lets virtual machines access
>> +a directory tree on the host. Unlike existing approaches, it
>> +is designed to offer local file system semantics and performance.
>> +
>> +See https://virtio-fs.gitlab.io/
>> +
>
>I'm lacking description of security implications. The above link doesn't
>do a good job to pointing to the relevant info. I've seen this document:
>
>https://gitlab.com/virtio-fs/qemu/-/commit/718c71fa44f6b92ac27558c903d27935236b08ef?merge_request_iid=6
>
>which describes it nicely so we should link to the formatted version of
>it probably.
>

That document was part of the v1 PULL request of virtiofsd to QEMU:
https://lists.nongnu.org/archive/html/qemu-devel/2020-01/msg05389.html
but due to a discussion about the file's location
https://lists.nongnu.org/archive/html/qemu-devel/2020-01/msg05733.html
it was dropped from v2:
https://lists.nongnu.org/archive/html/qemu-devel/2020-01/msg05780.html

Would you like me to include the link from the merge request instead?

Jano

>Other than that:
>
>Reviewed-by: Peter Krempa <pkrempa at redhat.com>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20200226/c6d08926/attachment-0001.sig>