docs: storage: Note that refreshing the storage pool is needed on outside modification

[PATCH] docs: storage: Note that refreshing the storage pool is needed on outside modification

Posted by Peter Krempa via Devel 2 weeks ago

From: Peter Krempa <pkrempa@redhat.com>

Add a note stating that pool contents and metadata are not auto-updated
when the pool is modified outside of libvirt.

Closes: https://gitlab.com/libvirt/libvirt/-/work_items/749
Signed-off-by: Peter Krempa <pkrempa@redhat.com>
---
 docs/formatstorage.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/docs/formatstorage.rst b/docs/formatstorage.rst
index 9d9a4143eb..7ed57732af 100644
--- a/docs/formatstorage.rst
+++ b/docs/formatstorage.rst
@@ -25,6 +25,13 @@ attribute ``type``, which is one of ``dir``, ``fs``, ``netfs``, ``disk``,
 ``iscsi-direct`` ( :since:`since 4.7.0` ). This corresponds to the storage
 backend drivers listed further along in this document.

+ .. note::
+  Any modification of the storage pool outside of libvirt or on a different
+  host for shared storage pools may not update the cached volume or pool
+  metadata. The pool metadata can be refreshed by calling
+  ``virsh pool-refresh POOLNAME`` or by the
+  `virStoragePoolRefresh <html/libvirt-libvirt-storage.html#virStoragePoolRefresh>`__ API.
+
 Storage pool general metadata
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-- 
2.53.0

Re: [PATCH] docs: storage: Note that refreshing the storage pool is needed on outside modification

Posted by Jiri Denemark via Devel 1 week, 6 days ago

On Mon, Mar 09, 2026 at 17:31:52 +0100, Peter Krempa wrote:
> From: Peter Krempa <pkrempa@redhat.com>
> 
> Add a note stating that pool contents and metadata are not auto-updated
> when the pool is modified outside of libvirt.
> 
> Closes: https://gitlab.com/libvirt/libvirt/-/work_items/749
> Signed-off-by: Peter Krempa <pkrempa@redhat.com>
> ---
>  docs/formatstorage.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/docs/formatstorage.rst b/docs/formatstorage.rst
> index 9d9a4143eb..7ed57732af 100644
> --- a/docs/formatstorage.rst
> +++ b/docs/formatstorage.rst
> @@ -25,6 +25,13 @@ attribute ``type``, which is one of ``dir``, ``fs``, ``netfs``, ``disk``,
>  ``iscsi-direct`` ( :since:`since 4.7.0` ). This corresponds to the storage
>  backend drivers listed further along in this document.
> 
> + .. note::
> +  Any modification of the storage pool outside of libvirt or on a different
> +  host for shared storage pools may not update the cached volume or pool
> +  metadata. The pool metadata can be refreshed by calling
> +  ``virsh pool-refresh POOLNAME`` or by the
> +  `virStoragePoolRefresh <html/libvirt-libvirt-storage.html#virStoragePoolRefresh>`__ API.
> +
>  Storage pool general metadata
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 

Reviewed-by: Jiri Denemark <jdenemar@redhat.com>