containerized-data-importer/doc/onboarding-storage-provisioners.md
Alex Kalenyuk 76f9c0a423
Add virt default storage class mention in onboarding doc (#3272)
Signed-off-by: Alex Kalenyuk <akalenyu@redhat.com>
2024-06-07 02:39:41 +02:00

2.1 KiB

Onboarding a storage provider to CDI

Introduction

As explained extensively in the storage profile documentation, CDI keeps internal knowledge
about a wide range of storage providers in order to provide defaults & hints as they are needed.
This doc is about "educating" CDI about a new storage provider.

StorageProfile.Spec fields

In order to onboard a storage provider, one should be able to pick the correct values for the storage profile parameters.
Detailed explanations and tips can be found in the storage profile's parameters section.

For example, for ceph rbd, CDI knows that:

Default Virtualization Storage Class

A default virtualization storage class is defined as a storage class preferrable for VM workloads (certain combination of storage class parameters that benefit VMs) and is annotated with storageclass.kubevirt.io/is-default-virt-class set to "true".
For a DataVolume request that does not explicitly specify a storage class name, such a storage class takes precedence over the k8s default storage class.
Advertising such a storage class via documentation makes sense in certain cases.

Checkup framework - kubevirt storage checkup

In order to validate the changes and choices that were made, one can run the https://github.com/kiagnose/kubevirt-storage-checkup