[lxc-devel] [lxd/master] doc/storage: Document block storage volumes

[stgraber on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 354 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20200628/94c4dfa4/attachment.bin>
-------------- next part --------------
From 7d15c496bf0ee4b4c010b2c766e6d6bb20094eee Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Graber?= <stgraber at ubuntu.com>
Date: Sun, 28 Jun 2020 22:36:43 -0400
Subject: [PATCH] doc/storage: Document block storage volumes
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Stéphane Graber <stgraber at ubuntu.com>
---
 doc/storage.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/doc/storage.md b/doc/storage.md
index 8a72415c60..5c06473e7b 100644
--- a/doc/storage.md
+++ b/doc/storage.md
@@ -65,6 +65,21 @@ Storage volume configuration keys can be set using the lxc tool with:
 lxc storage volume set [<remote>:]<pool> <volume> <key> <value>
 ```
 
+## Storage volume content types
+Storage volumes can be either `filesystem` or `block` type.
+
+Containers and container images are always going to be using `filesystem`.
+Virtual machines and virtual machine images are always going to be using `block`.
+
+Custom storage volumes can be either types with the default being `filesystem`.
+Those custom storage volumes of type `block` can only be attached to virtual machines.
+
+Block custom storage volumes can be created with:
+
+```bash
+lxc storage volume create [<remote>]:<pool> <name> --type=block
+```
+
 # Where to store LXD data
 Depending on the storage backends used, LXD can either share the filesystem with its host or keep its data separate.