Skip to content

Commit

Permalink
doc: Update block volume usage
Browse files Browse the repository at this point in the history
Signed-off-by: hamistao <pedro.ribeiro@canonical.com>
  • Loading branch information
hamistao committed Jul 8, 2024
1 parent 090c35a commit 911b153
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/explanation/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Storage volumes can be of the following types:

`custom`
: You can add one or more custom storage volumes to hold data that you want to store separately from your instances.
Custom storage volumes can be shared between instances, and they are retained until you delete them.
Custom storage volumes of content type `filesystem` or `iso` can be shared between instances, and they are retained until you delete them.

You can also use custom storage volumes to hold your backups or images.

Expand All @@ -154,7 +154,8 @@ Each storage volume uses one of the following content types:
You can create a custom storage volume of type `block` by using the `--type=block` flag.

Custom storage volumes of content type `block` can only be attached to virtual machines.
They should not be shared between instances, because simultaneous access can lead to data corruption.
By default, they can only be attached to one instance at a time, because simultaneous access can lead to data corruption.
Sharing a custom storage volumes of content type `block` is made possible through the usage of the `security.shared` configuration key.

`iso`
: This content type is used for custom ISO volumes.
Expand Down
1 change: 1 addition & 0 deletions doc/howto/storage_volumes.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ The following restrictions apply:
- To avoid data corruption, storage volumes of {ref}`content type <storage-content-types>` `block` should never be attached to more than one virtual machine at a time.
- Storage volumes of {ref}`content type <storage-content-types>` `iso` are always read-only, and can therefore be attached to more than one virtual machine at a time without corrupting data.
- File system storage volumes can't be attached to virtual machines while they're running.
- Custom block storage volumes that don't have `security.shared` enabled cannot be attached to more than one instance at the same time and neither can be attached to profiles.

For custom storage volumes with the content type `filesystem`, use the following command, where `<location>` is the path for accessing the storage volume inside the instance (for example, `/data`):

Expand Down

0 comments on commit 911b153

Please sign in to comment.