Skip to content

This PR is to add comments to WithAnnotations in fluid/pkg/ddc/base/runtime.go #5842

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
66RomanReigns wants to merge 1 commit into
base: master
Choose a base branch
from
+13 −0
Open

This PR is to add comments to WithAnnotations in fluid/pkg/ddc/base/runtime.go #5842

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions pkg/ddc/base/runtime.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,19 @@ func (info *RuntimeInfo) GetMetadataList() []datav1alpha1.Metadata {
return info.metadataList
}

// WithAnnotations creates a RuntimeInfoOption that sets the annotations field of RuntimeInfo.
// The annotations map usually comes from the Kubernetes runtime object, such as AlluxioRuntime,
// JindoRuntime, GooseFSRuntime, JuiceFSRuntime, ThinRuntime, EFCRuntime, VineyardRuntime, or CacheRuntime.
Comment on lines +229 to +230
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 9, 2026

Choose a reason for hiding this comment

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

medium

Hardcoding a specific list of all supported runtime types in the documentation is brittle and creates a maintenance burden, as this comment will need to be updated whenever a new runtime is added to Fluid. It is better to use a more generic description with a few examples to improve maintainability and consistency with other functions in this file (e.g., GetMetadataListFromAnnotation).

Suggested change
// The annotations map usually comes from the Kubernetes runtime object, such as AlluxioRuntime,
// JindoRuntime, GooseFSRuntime, JuiceFSRuntime, ThinRuntime, EFCRuntime, VineyardRuntime, or CacheRuntime.
// The annotations map usually comes from the Kubernetes runtime object (e.g., AlluxioRuntime, JindoRuntime, etc.).

// These annotations are stored in RuntimeInfo so that other components can later retrieve them through
// GetAnnotations and use them when building, reconciling, or processing runtime-related resources.
// The function itself does not validate, copy, or transform the input annotations map; it directly assigns
// the provided map to RuntimeInfo.annotations.
//
// Parameters:
// - annotations: A map containing annotation key-value pairs associated with the runtime object.
//
// Returns:
// - RuntimeInfoOption: An option function that writes the given annotations into RuntimeInfo.
func WithAnnotations(annotations map[string]string) RuntimeInfoOption {
return func(info *RuntimeInfo) error {
info.annotations = annotations
Expand Down
Loading