update comments and exception related to kvm.snapshot.enabled setting - #13733
Open
sudo87 wants to merge 1 commit into
Open
update comments and exception related to kvm.snapshot.enabled setting#13733sudo87 wants to merge 1 commit into
sudo87 wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the in-code documentation and runtime exception text related to the kvm.snapshot.enabled global setting, clarifying how it affects snapshot support for running VMs on KVM.
Changes:
- Renames a private helper to fix a spelling error (
hostSupportsSnapsthotForVolume→hostSupportsSnapshotForVolume). - Updates comments describing
kvm.snapshot.enabledbehavior for KVM volume snapshots. - Rewords the exception thrown when snapshots are blocked for running VMs due to
kvm.snapshot.enabled=false.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
server/src/main/java/com/cloud/storage/snapshot/SnapshotManagerImpl.java |
Fixes helper method spelling and updates KVM snapshot-related comment and exception message text. |
server/src/main/java/com/cloud/storage/snapshot/SnapshotManager.java |
Minor wording fix in the kvm.snapshot.enabled ConfigKey description. |
Comments suppressed due to low confidence (1)
server/src/main/java/com/cloud/storage/snapshot/SnapshotManagerImpl.java:1593
- This exception message is internally inconsistent: it says kvm.snapshot.enabled is already set to false, then immediately says "It can be disabled". Consider rephrasing to explain that it is sometimes set to false to avoid corruption, and how to re-enable it.
"KVM Snapshot is not supported for Running VMs because the global setting " +
"kvm.snapshot.enabled is set to false for this deployment. It can be disabled to " +
"avoid a possible volume corruption in certain cases. To allow snapshots of running " +
"VMs, set kvm.snapshot.enabled to true. See the documentation for more details.");
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #13733 +/- ##
============================================
- Coverage 19.65% 19.64% -0.01%
+ Complexity 19792 19789 -3
============================================
Files 6368 6368
Lines 574881 574881
Branches 70351 70351
============================================
- Hits 112970 112963 -7
- Misses 449639 449647 +8
+ Partials 12272 12271 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR fixes comment and exception related to kvm.snapshot.enabled setting.
Doc PR: apache/cloudstack-documentation#673
Types of changes
Feature/Enhancement Scale or Bug Severity
Feature/Enhancement Scale
Bug Severity
Screenshots (if appropriate):
How Has This Been Tested?
How did you try to break this feature and the system with this change?