Skip to content

docs: clarify StorageClass sync note across all versioned docs - #1125

Open
rajeshkio wants to merge 1 commit into
harvester:mainfrom
rajeshkio:main
Open

rajeshkio wants to merge 1 commit into
harvester:mainfrom
rajeshkio:main

Conversation

@rajeshkio

@rajeshkio rajeshkio commented Sep 9, 2026 •

Copy link
Copy Markdown

Problem:

The documentation for VM image sync during cluster restore states that the controller automatically syncs virtual machine images to the new cluster, but doesn't mention that each image's associated StorageClass is also synced as part of this process. This omission could lead users to assume StorageClasses need to be manually recreated after a cluster restore.

Solution:

Updated the description to clarify that StorageClasses associated with each virtual machine image are also synced automatically to the new cluster, alongside the image itself. Applied consistently across the current docs and all affected versioned doc snapshots (v1.4–v1.8).

Related Issue(s):

harvester/harvester#11613

@rajeshkio
rajeshkio requested review from a team and jillian-maroket as code owners September 9, 2026 04:56
Signed-off-by: Rajesh Kumar <rajesh.kumar@suse.com>
@mergify

mergify Bot commented Sep 14, 2026

Copy link
Copy Markdown

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

Comment thread docs/vm/backup-restore.md
#### Prerequisites

- v1.4.0 and later: The controller automatically syncs the virtual machine images with the new cluster, except when a virtual machine image with the same name or display name already exists on the new cluster.
- v1.4.0 and later: The controller automatically syncs the virtual machine images with the new cluster, along with their associated StorageClasses, except when a virtual machine image with the same name or display name already exists on the new cluster.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not all StorageClass would be synced.
IIUC, only the backing image (vmimage) would be synced.

cc @WebberHuang1118, please correct me if I am wrong.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes, you are right, only the sc related to V1 VMImage. We should provide more detailed context instead of saying that the associated StorageClasses are synced:

  • Currently, VM Backup and Restore supports only Longhorn v1 volumes.
  • Harvester can automatically back up VMImages to the remote backup target. However, both the backup and restore clusters must be running Harvester v1.4.0 or later. See the prerequisites. In addition, the two clusters should not have VMImages with duplicate names or display names.
  • The backup target Refresh Interval setting affects how frequently Harvester discovers existing VMBackups and VMImages from the remote backup target. See Configure Backup Target.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I am thinking of this rewrite, does it looks okay @WebberHuang1118

v1.4.0 and later: Harvester can automatically back up VMImages to the remote backup target. Both the backup and restore clusters must be running Harvester v1.4.0 or later, and should not have VMImages with duplicate names or display names; sync is skipped for a VMImage if one already exists with the same name or display name. The controller also syncs each VMImage's associated StorageClass. The backup target Refresh Interval setting affects how frequently Harvester discovers existing VMBackups and VMImages from the remote backup target. See Configure Backup Target.

Your first point is already present in the doc

"Backup support is currently limited to Longhorn V1 Data Engine volumes. Harvester is unable to create backups of volumes in external storage."

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, thanks

@rajeshkio

Copy link
Copy Markdown
Author

VMI associated storageclass are the one auto-created when we import an image right? The document update is meant to rely that information only.

@WebberHuang1118 WebberHuang1118 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for the improvement, please check https://github.com/harvester/docs/pull/1125/changes#r4005984249, thanks.

@github-actions

Copy link
Copy Markdown
Name Link
🔨 Latest commit 844a7ed
😎 Deploy Preview https://6aa80044d9ad4f2d7e43e9ea--harvester-preview.netlify.app

@WebberHuang1118
WebberHuang1118 self-requested a review September 22, 2026 01:35

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants