docs: add third-party storage docs by Vicente-Cheng · Pull Request #728 · harvester/docs

Vicente-Cheng · 2025-03-17T16:18:14Z

Add third-party storage support docs.

github-actions · 2025-03-17T16:39:04Z

Name	Link
🔨 Latest commit	`64045a2`
😎 Deploy Preview	https://68059f3481d35c16594a991b--harvester-preview.netlify.app

docs/advanced/csidriver.md

docs/vm/backup-restore.md

docs/advanced/csidriver.md

docs/vm/create-vm.md

docs/vm/edit-vm.md

jillian-maroket

Initial review done. Please check my comments.

docs/advanced/csidriver.md

jillian-maroket · 2025-03-19T08:29:34Z

docs/advanced/csidriver.md

-:::note
+:::important
+
+The Support Matrix below shows the capabilities of the validated CSI drivers.


Suggested change

The Support Matrix below shows the capabilities of the validated CSI drivers.

The following table outlines the capabilities supported by the validated CSI drivers.

jillian-maroket · 2025-03-19T09:19:31Z

docs/advanced/csidriver.md

+For the Harvester functions to work well, the third-party CSI driver might better to have the following capabilities:
+- Support expansion, for online resizing of the volume
+- Support snapshot, for take snapshot of the volume/VM
+- Support clone, for clone volume/VM


Suggested change

For the Harvester functions to work well, the third-party CSI driver might better to have the following capabilities:

- Support expansion, for online resizing of the volume

- Support snapshot, for take snapshot of the volume/VM

- Support clone, for clone volume/VM

To enable Harvester to function well, use CSI drivers that support the following capabilities:

- Volume expansion (online resizing)

- Snapshot creation (volume and virtual machine snapshots)

- Cloning (volume and virtual machine clones)

- Usage of Read-Write-Many (RWX) volumes for [Live Migration](../vm/live-migration.md)

docs/advanced/csidriver.md

docs/image/image-security.md

docs/vm/backup-restore.md

docs/vm/edit-vm.md

docs/volume/export-volume.md

Vicente-Cheng · 2025-03-24T16:47:38Z

I don't know if we're allowed to link to HEPs. The end user doc should focus on key concepts and operational procedures. Design and implementation details can be discussed only if users are required to understand them. Please check if the topics in this section must really be included.

The topic Advanced/Internal Topics I used to introduce the StorageProfile concept because this concept is very important once user wants to use their own storage solution. We need to let them know how they should configure.
Because of that, I added this topic.
Or did you think I just mentioned the StorageProfile for something topic like Advanced?

WDYT for this section? cc @ihcsim, @bk201, @WebberHuang1118, @jillian-maroket

ihcsim · 2025-03-24T23:14:00Z

@Vicente-Cheng I am not sure if we are responsible for providing storage profile examples in our documentation. IIUC, we just need users to know it will work out-of-box because Harvester integrated with CDI, right? It's not mandatory to use storage profiles in Harvester. For some well-known provisioners, CDI might even auto-create the storage profiles based on their storage classes.

If this is just for the user's FYI, would something like this make sense:

"By integrating Harvester with CDI, you can now utilize the CDI API to create custom storage profiles to simplify your data volumes definition. Storage profiles allow multiple data volumes to share the same provisioner settings.

Here is an example of a LVM storage profile: // personally, i might even omit this part

# insert example

For more information on storage profiles, refer to the CDI documentation."

Other suggestions on the same section:

Omit the "Top level architecture" section. HEP sounds like a better home for it
Omit the clone strategies. We are not responsible for explaining CDI concepts

jillian-maroket

I reviewed the parts that were skipped in the initial review. Note that I agree with Ivan's suggestions, which are reflected in my recommended wording and structural changes.

docs/advanced/csidriver.md

docs/vm/create-vm.md

docs/vm/edit-vm.md

docs/advanced/csidriver.md

Vicente-Cheng · 2025-03-27T16:46:59Z

I reviewed the parts that were skipped in the initial review. Note that I agree with Ivan's suggestions, which are reflected in my recommended wording and structural changes.

All updated!
Thanks for the review, please recheck.

ihcsim

LGTM - just 2 minor suggestions.

docs/advanced/csidriver.md

WebberHuang1118

LGTM, thanks.

Vicente-Cheng · 2025-04-17T08:47:06Z

Hi folks,
I added the two parts. Please help review them again.

Added the validated CSI driver. (Even the same storage solution would use a different CSI driver, so I specify the CSI driver we validated)
I added the NFS server-side configuration (squash related) to give the user a hint on how to configure it to make things go well.

Vicente-Cheng · 2025-04-18T02:55:52Z

Hi folks,
I also added the known issue part for [DOC] Adjusting CDI filesystemOverhead to prevent scratch volume space shortage

Also, remove the old all-in-one NFS server + CSI driver on Deploy the Combined NFS Service and CSI Driver

Please help review them. Thanks!

WebberHuang1118

LGTM, thanks.

jillian-maroket

I reviewed the new text.

docs/advanced/csidriver.md

Signed-off-by: Vicente Cheng <vicente.cheng@suse.com> Co-authored-by: Jillian Maroket <jillian.maroket@suse.com> Co-authored-by: Ivan Sim <ivan.sim@suse.com> Co-authored-by: David Ko <dko@suse.com> Co-authored-by: Volker Theile <votdev@gmx.de>

WebberHuang1118

LGTM, thanks.

Vicente-Cheng requested review from WebberHuang1118, bk201, ibrokethecloud, ihcsim, innobead and jillian-maroket March 17, 2025 16:18

Vicente-Cheng mentioned this pull request Mar 18, 2025

[BUG] Can't export volume to image with Longhorn v2 external storage harvester/harvester#7854

Closed

ihcsim reviewed Mar 18, 2025

View reviewed changes

jillian-maroket reviewed Mar 19, 2025

View reviewed changes

Vicente-Cheng force-pushed the 3rd-party-docs branch from f8e9b9d to 3a842fa Compare March 24, 2025 16:44

Vicente-Cheng requested review from ihcsim and jillian-maroket March 24, 2025 16:44

jillian-maroket reviewed Mar 27, 2025

View reviewed changes

innobead reviewed Mar 27, 2025

View reviewed changes

docs/advanced/csidriver.md Outdated Show resolved Hide resolved

Vicente-Cheng force-pushed the 3rd-party-docs branch from fb7a0f9 to 336718c Compare March 27, 2025 16:45

Vicente-Cheng requested a review from jillian-maroket March 27, 2025 16:45

ihcsim previously approved these changes Mar 31, 2025

View reviewed changes

docs/advanced/csidriver.md Outdated Show resolved Hide resolved

docs/advanced/csidriver.md Show resolved Hide resolved

jillian-maroket previously approved these changes Apr 1, 2025

View reviewed changes

Vicente-Cheng dismissed stale reviews from jillian-maroket and ihcsim via 68d7ec2 April 2, 2025 15:07

Vicente-Cheng force-pushed the 3rd-party-docs branch from 336718c to 68d7ec2 Compare April 2, 2025 15:07

Vicente-Cheng requested review from ihcsim, innobead and jillian-maroket April 2, 2025 15:08

ihcsim previously approved these changes Apr 2, 2025

View reviewed changes

WebberHuang1118 previously approved these changes Apr 10, 2025

View reviewed changes

Vicente-Cheng dismissed stale reviews from jillian-maroket and WebberHuang1118 via 549cf0d April 17, 2025 08:41

Vicente-Cheng force-pushed the 3rd-party-docs branch from fa6f3a7 to 549cf0d Compare April 17, 2025 08:41

Vicente-Cheng requested review from WebberHuang1118, bk201, ihcsim and jillian-maroket April 17, 2025 08:45

Vicente-Cheng force-pushed the 3rd-party-docs branch 2 times, most recently from 2c07329 to 252c59e Compare April 18, 2025 02:54

bk201 previously approved these changes Apr 18, 2025

View reviewed changes

ihcsim previously approved these changes Apr 18, 2025

View reviewed changes

WebberHuang1118 previously approved these changes Apr 18, 2025

View reviewed changes

jillian-maroket reviewed Apr 18, 2025

View reviewed changes

Vicente-Cheng dismissed stale reviews from WebberHuang1118, ihcsim, and bk201 via edfefd8 April 21, 2025 01:08

docs: add third-party storage docs

64045a2

Signed-off-by: Vicente Cheng <vicente.cheng@suse.com> Co-authored-by: Jillian Maroket <jillian.maroket@suse.com> Co-authored-by: Ivan Sim <ivan.sim@suse.com> Co-authored-by: David Ko <dko@suse.com> Co-authored-by: Volker Theile <votdev@gmx.de>

Vicente-Cheng force-pushed the 3rd-party-docs branch from edfefd8 to 64045a2 Compare April 21, 2025 01:09

Vicente-Cheng requested review from WebberHuang1118, bk201, ihcsim and jillian-maroket April 21, 2025 01:09

jillian-maroket approved these changes Apr 21, 2025

View reviewed changes

WebberHuang1118 approved these changes Apr 21, 2025

View reviewed changes

bk201 approved these changes Apr 21, 2025

View reviewed changes

ihcsim approved these changes Apr 22, 2025

View reviewed changes

Vicente-Cheng merged commit 38303eb into harvester:main Apr 22, 2025
4 checks passed

votdev mentioned this pull request May 7, 2025

Fix typo #775

Merged

	The Support Matrix below shows the capabilities of the validated CSI drivers.
	The following table outlines the capabilities supported by the validated CSI drivers.

-For the Harvester functions to work well, the third-party CSI driver might better to have the following capabilities:
-- Support expansion, for online resizing of the volume
-- Support snapshot, for take snapshot of the volume/VM
-- Support clone, for clone volume/VM
+To enable Harvester to function well, use CSI drivers that support the following capabilities:
+- Volume expansion (online resizing)
+- Snapshot creation (volume and virtual machine snapshots)
+- Cloning (volume and virtual machine clones)
+- Usage of Read-Write-Many (RWX) volumes for [Live Migration](../vm/live-migration.md)

Conversation

Vicente-Cheng commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jillian-maroket left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jillian-maroket Mar 19, 2025

Choose a reason for hiding this comment

Uh oh!

jillian-maroket Mar 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Vicente-Cheng commented Mar 24, 2025

Uh oh!

ihcsim commented Mar 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jillian-maroket left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Vicente-Cheng commented Mar 27, 2025

Uh oh!

ihcsim left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

WebberHuang1118 left a comment

Choose a reason for hiding this comment

Uh oh!

Vicente-Cheng commented Apr 17, 2025

Uh oh!

Vicente-Cheng commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

WebberHuang1118 left a comment

Choose a reason for hiding this comment

Uh oh!

jillian-maroket left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

WebberHuang1118 left a comment

Vicente-Cheng commented Mar 17, 2025 •

edited

Loading

github-actions bot commented Mar 17, 2025 •

edited

Loading

ihcsim commented Mar 24, 2025 •

edited

Loading

Vicente-Cheng commented Apr 18, 2025 •

edited

Loading