doc: clarify image display name uniqueness for all creation methods#1028
Open
Hero2633 wants to merge 2 commits into
Open
doc: clarify image display name uniqueness for all creation methods#1028Hero2633 wants to merge 2 commits into
Hero2633 wants to merge 2 commits into
Conversation
Signed-off-by: zuoyi.wan <zuoyi.wan@winicssec.com>
akashraj4261
approved these changes
Apr 29, 2026
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
2 participants
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.
Problem:
The Harvester documentation did not explicitly state that the Display Name of a VM image must be unique within the same namespace. This lack of clarity can lead users to use duplicate names, which may trigger finalizer deadlocks during image deletion, as identified in the core Harvester repository.
Solution:
Added a global :::important callout in the Upload Images guide. This notice clarifies the uniqueness requirement for the displayName field across all creation methods (URL, Local File, and Volume Export) to prevent potential operational conflicts.
Related Issue(s):
This documentation update is requested by maintainers in harvester/harvester#10113.
Test plan:
This is a documentation-only change. Verified the Markdown syntax and callout placement to ensure it renders correctly in the user guide.
Additional documentation or context
N/A