Skip to content

This PR is to add comments to checkIfRemountRequired in ufs.go #6084

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

Merged
cheyang merged 2 commits into from
Jul 3, 2026
+10 −0
Merged

This PR is to add comments to checkIfRemountRequired in ufs.go #6084

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6fb3622
Add comments to checkIfRemountRequired in ufs.go
uglis Jun 29, 2026
d0bb7bf
Update comments to checkIfRemountRequired per review feedback
uglis Jun 30, 2026
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
10 changes: 10 additions & 0 deletions pkg/ddc/alluxio/ufs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,16 @@ func (e *AlluxioEngine) UpdateOnUFSChange(ufsToUpdate *utils.UFSToUpdate) (updat
return
}

// checkIfRemountRequired checks whether a remount operation is needed for the given UFS.

@cheyang cheyang Jun 30, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

A few lines below, ShouldSyncDatasetMounts uses the project's richer doc-comment template with explicit Parameters: and Returns: sections. Since you're adding fresh documentation here anyway, it would be nice to mirror that format for in-file consistency — for example noting that ufsToUpdate is an in/out parameter that the function may mutate (via AddMountPaths) to carry new mount paths back to the caller. Purely a consistency suggestion, not a blocker.

// It compares the runtime's MountTime with the Alluxio master container's start time.
// If the master container started after the last mount, the in-memory mount state may not
// have survived the restart, so it finds unmounted UFS paths and adds them to ufsToUpdate
// for remount scheduling. If no paths need remounting, it refreshes the runtime's MountTime
// to prevent the check from re-firing on every reconcile.
//
// Parameters:
// - ufsToUpdate (*utils.UFSToUpdate): An in/out parameter that may be mutated via
// AddMountPaths to carry unmounted paths back to the caller for remount scheduling.
func (e *AlluxioEngine) checkIfRemountRequired(ufsToUpdate *utils.UFSToUpdate) {
runtime, err := e.getRuntime()
if err != nil {
Expand Down
Loading