-
Notifications
You must be signed in to change notification settings - Fork 3
Add the storage architecture page. #1
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.
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
Open
pykello
wants to merge
1
commit into
main
Choose a base branch
from
pykello/storage
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
title: 'Storage Architecture' | ||
--- | ||
|
||
import { Link } from '/snippets/link.mdx'; | ||
|
||
Ubicloud provides encrypted, non-replicated storage for each VM. To do this, we use | ||
<Link title="SPDK" url="https://spdk.io/"/> (Storage Performance Development Toolkit). | ||
SPDK is an open-source set of tools and libraries for building high-performance, scalable, | ||
and efficient storage applications. SPDK uses a layered block device (bdev) framework, | ||
where each layer provides a specific function like file access, NVMe access, encryption, | ||
or compression. | ||
|
||
Each VM can have multiple disks. Disks are indexed starting at zero. A disk | ||
can be based on an OS image. OS images are stored at `/var/storage/images/`. Files | ||
specific to each disk is stored at `/var/storage/${vm_name}/${disk_index}`. This directory | ||
has 3 files: | ||
|
||
* `disk.raw`: Disk's actual data. Same size as the disk. | ||
* `data_encryption_key.json`: Encryption parameters of the disk. Keys inside this file | ||
are encrypted using KEK (Key Encryption Key). See <Link title="this blogpost" url="https://www.ubicloud.com/blog/ubicloud-block-storage-encryption"/> | ||
for more details. | ||
* `vhost.sock`: Unix domain socket which is used for communication between the VMM (Virtual | ||
Machine Monitor) and SPDK. We use Cloud-Hypervisor as the VMM. | ||
|
||
In SPDK we create the following objects for each disk: | ||
|
||
* **The file access bdev**: this is used to read from and write to `disk.raw`, and is | ||
created using the `bdev_aio_create` SPDK json-rpc command. | ||
* **The encryption key**: which is named `${vm_name}_${disk_index}_key`. This is created | ||
using the `accel_crypto_key_create` SPDK json-rpc command. | ||
* **The encryption bdev**: which is layered on top of the file access bdev, and is | ||
created using the `bdev_crypto_create` SPDK json-rpc command. | ||
* **The copy-on-write layer**: which is layered on top of the encryption bdev & provides | ||
copy-on-write from an OS image. This is created using the `bdev_ubi_create` json-rpc | ||
command. | ||
* **The vhost controller**: which is used to create the `vhost.sock` unix domain socket. | ||
|
||
Finally, we add the following argument to Cloud-Hyperisor's command line, which attaches | ||
the disk to the VM: `--disk vhost_user=true,socket=#{vhost_socket_path},num_queues=1,queue_size=256`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed the custom component and accomplished the task using custom CSS. Now, you can simply use plain markdown links.
#5