Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Prevent custom block volume sharing #13183

Merged
merged 13 commits into from
Jul 11, 2024
Merged

Prevent custom block volume sharing #13183

merged 13 commits into from
Jul 11, 2024

Conversation

hamistao
Copy link
Contributor

@hamistao hamistao commented Mar 20, 2024 •
edited
Loading

Closes #12254.
Changes mostly based on lxc/incus#467 and lxc/incus#529.
This creates the security.shared config key for block volumes and adds checks for it during device creation and instance start.
This also includes checks for path definition when adding custom volume devices to profiles (filesystem volumes require a path and block volumes don't) and does some refactoring on the validateConfig function to make the disk validation process more readable.

@github-actions github-actions bot added Documentation Documentation needs updating API Changes to the REST API labels Mar 20, 2024
@hamistao hamistao force-pushed the issue12254/check_custom_block_storage_volume_sharing branch from 0488bfa to 087ec55 Compare March 20, 2024 14:11
@hamistao hamistao marked this pull request as draft March 20, 2024 14:17
@hamistao hamistao force-pushed the issue12254/check_custom_block_storage_volume_sharing branch 8 times, most recently from 28a7e15 to e7b3abb Compare March 21, 2024 11:45
@hamistao hamistao marked this pull request as ready for review March 21, 2024 13:42
@hamistao hamistao force-pushed the issue12254/check_custom_block_storage_volume_sharing branch from e7b3abb to ecf80be Compare March 21, 2024 20:42
@hamistao hamistao mentioned this pull request Mar 22, 2024
Merged
tomponline
tomponline reviewed Mar 27, 2024
View reviewed changes
lxd/device/disk.go Outdated Show resolved Hide resolved
tomponline
tomponline reviewed Mar 27, 2024
View reviewed changes
lxd/device/disk.go Outdated Show resolved Hide resolved
tomponline
tomponline requested changes Mar 27, 2024
View reviewed changes
Copy link
Member

@tomponline tomponline left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly just nits and small tweaks to address.

@github-actions GitHub Actions
Copy link

Heads up @ru-fu - the "Documentation" label was applied to this issue.

@hamistao hamistao force-pushed the issue12254/check_custom_block_storage_volume_sharing branch 5 times, most recently from e1dbfa5 to 1ab84a8 Compare March 28, 2024 10:39
tomponline
tomponline reviewed Mar 28, 2024
View reviewed changes
lxd/device/disk.go Outdated Show resolved Hide resolved
tomponline
tomponline requested changes Mar 28, 2024
View reviewed changes
Copy link
Member

@tomponline tomponline left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you can create block volumes and attach them to profiles in the main test suite we should have a check for that in this PR too.

Also please can you add a check to https://github.com/canonical/lxd-ci/blob/main/tests/storage-volumes-vm for per-VM disk devices.

@hamistao hamistao force-pushed the issue12254/check_custom_block_storage_volume_sharing branch 3 times, most recently from a6b885b to 60b18a7 Compare July 4, 2024 16:09
@hamistao
Copy link
Contributor Author

hamistao commented Jul 4, 2024

@tomponline Requested changes made and pushed

@hamistao hamistao force-pushed the issue12254/check_custom_block_storage_volume_sharing branch from 60b18a7 to ea842ab Compare July 4, 2024 16:55
tomponline
tomponline reviewed Jul 5, 2024
View reviewed changes
lxd/device/disk.go Outdated Show resolved Hide resolved
tomponline
tomponline reviewed Jul 5, 2024
View reviewed changes
lxd/device/disk.go Outdated Show resolved Hide resolved
tomponline
tomponline reviewed Jul 5, 2024
View reviewed changes
lxd/device/disk.go Outdated Show resolved Hide resolved
ru-fu
ru-fu reviewed Jul 5, 2024
View reviewed changes
doc/api-extensions.md Outdated Show resolved Hide resolved
doc/explanation/storage.md Outdated
@@ -154,7 +154,7 @@ 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
By default they can only be attached to one instance at a time, 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.
Set the `security.shared` storage option to allow sharing volumes between instances.

doc/explanation/storage.md Outdated
@@ -154,7 +154,7 @@ 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, missed your comment Tom! But yes, adding that here makes sense. Unfortunately we can't link to the option since it's specific to the storage driver. :(

doc/explanation/storage.md Outdated
@@ -154,7 +154,7 @@ 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regarding the profiles, I don't think it's needed here (because it's implied by saying they can only be attached to one instance). So it makes sense to add it to the how-to like you did.

monstermunchkin and others added 13 commits July 8, 2024 09:58
@monstermunchkin @hamistao
api: Add shared_custom_block_volumes API extension
70d8d2e 
Signed-off-by: Thomas Hipp <[email protected]>
(cherry picked from commit b8d3d735dffe6c587ed0b8965288122f63dfc108)
Signed-off-by: hamistao <[email protected]>
License: Apache-2.0
@monstermunchkin @hamistao
lxd/device/config: Fix return values of Update function
c48ce5a 
The `Update` function returns `map[string]Device` values despite there
being a `Devices` type which is the same thing.

This commit changes the return types to be `Devices` instead.

Signed-off-by: Thomas Hipp <[email protected]>
(cherry picked from commit 6fff607f8462237843a590751d7afcb38335e3f4)
Signed-off-by: hamistao <[email protected]>
License: Apache-2.0
@hamistao
lxd: Rename ErrInstanceListStop to ErrListStop
a295e4f 
Signed-off-by: hamistao <[email protected]>
@monstermunchkin @hamistao
lxd/device: Validate shared block devices
43a1a55 
This validates shared custom block volumes. Such volumes can be attached
to profiles only if `security.shared` is `true`. Also, they can only be
attached to more than one instance if `security.shared` is `true`.

Signed-off-by: Thomas Hipp <[email protected]>
(cherry picked from commit 78315b5d6d8b1783604b482dec5c210767597098)
Signed-off-by: hamistao <[email protected]>
License: Apache-2.0
@monstermunchkin @hamistao
lxd/storage: Handle security.shared update
cceef37 
This handles the `security.shared` config key update. If a shared custom
storage block volume is attached to a profile, this volume cannot be
un-shared. Furthermore, if such a volume is attached to more than one
instance, it also cannot be un-shared.

Signed-off-by: Thomas Hipp <[email protected]>
(cherry picked from commit 29b45bb029d3a447e80a3e6f20e19658183ffb36)
Signed-off-by: hamistao <[email protected]>
License: Apache-2.0
@monstermunchkin @hamistao
lxd/storage: Allow security.shared key for custom block volumes
40a1293 
Signed-off-by: Thomas Hipp <[email protected]>
(cherry picked from commit 6e4e6b6b2061ad719ec576ee143e20f1b208b411)
Signed-off-by: hamistao <[email protected]>
License: Apache-2.0
@monstermunchkin @hamistao
lxd/storage/drivers: Handle security.shared in fillVolumeConfig
07d06aa 
Signed-off-by: Thomas Hipp <[email protected]>
(cherry picked from commit 606b833d1a67a3d8bc3e7cec032889c372229242)
Signed-off-by: hamistao <[email protected]>
License: Apache-2.0
@stgraber @hamistao
lxd/device/disk: Fix incorrect block volume usage
fb1cbbd 
Signed-off-by: Stéphane Graber <[email protected]>
(cherry picked from commit 32a4beecbf8098fdbb15ef5f36088956922630f7)
Signed-off-by: hamistao <[email protected]>
License: Apache-2.0
@hamistao
lxd/device: Update confusing error message
1465885 
This check is not for when the path property is missing, but to check if
a device that is not a root disk (and therefore its path is different
from '/') has a source property defined

Signed-off-by: hamistao <[email protected]>
@hamistao
lxd/storage: Add comments for metadata generation
362734e 
Signed-off-by: hamistao <[email protected]>
@hamistao
metadata: Add references to security.shared
3fd9768 
Signed-off-by: hamistao <[email protected]>
@hamistao
test: Add test for adding block volumes to profile
090c35a 
Signed-off-by: hamistao <[email protected]>
@hamistao
doc: Update block volume usage
911b153 
Signed-off-by: hamistao <[email protected]>
@hamistao hamistao force-pushed the issue12254/check_custom_block_storage_volume_sharing branch from ea842ab to 911b153 Compare July 8, 2024 14:19
@tomponline
Copy link
Member

@hamistao did you address @ru-fu suggestions yet on this? Thanks

@hamistao
Copy link
Contributor Author

hamistao commented Jul 8, 2024

@ru-fu Thanks for the suggestions, the changes were made.
@tomponline Suggested changes were made, how should we proceed regarding having VMs with shared block volumes not starting after the update?

ru-fu
ru-fu approved these changes Jul 9, 2024
View reviewed changes
Copy link
Contributor

@ru-fu ru-fu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs looks good. :)

tomponline
tomponline approved these changes Jul 11, 2024
View reviewed changes
Copy link
Member

@tomponline tomponline left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@tomponline tomponline dismissed roosterfish’s stale review July 11, 2024 10:06

We discussed this and because it will only affect custom block volumes that are actively shared with multiple VMs already, this is likely very niche (due to the risk of data corruption) and thus we would expect the operator to update the volume with security.share=true if they really intend to do this.

@tomponline tomponline merged commit 533ff3d into canonical:main Jul 11, 2024
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@roosterfish roosterfish roosterfish left review comments

@tomponline tomponline tomponline approved these changes

@ru-fu ru-fu ru-fu approved these changes

Assignees
No one assigned
Labels
API Changes to the REST API Documentation Documentation needs updating
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Prevent custom storage volumes to be used more than once
6 participants
@hamistao @tomponline @roosterfish @ru-fu @monstermunchkin @stgraber