Skip to content

doc: clarify image display name uniqueness for all creation methods#1028

Open
Hero2633 wants to merge 2 commits into
harvester:mainfrom
Hero2633:doc-fix-image-displayname-uniqueness
Open

doc: clarify image display name uniqueness for all creation methods#1028
Hero2633 wants to merge 2 commits into
harvester:mainfrom
Hero2633:doc-fix-image-displayname-uniqueness

Conversation

@Hero2633

Copy link
Copy Markdown

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

Signed-off-by: zuoyi.wan <zuoyi.wan@winicssec.com>
@mergify

mergify Bot commented Jun 19, 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

@Hero2633

Copy link
Copy Markdown
Author

@Mergifyio queue

@mergify

mergify Bot commented Jun 19, 2026

Copy link
Copy Markdown

queue

☑️ Command disallowed due to command restrictions in the Mergify configuration.

Details
  • sender-permission >= write

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.

2 participants