* feat(remote): add -noSync flag to skip upfront metadata pull on mount Made-with: Cursor * refactor(remote): split mount setup from metadata sync Extract ensureMountDirectory for create/validate; call pullMetadata directly when sync is needed. Caller controls sync step for -noSync. Made-with: Cursor * fix(remote): validate mount root when -noSync so bad bucket/creds fail fast When -noSync is used, perform a cheap remote check (ListBuckets and verify bucket exists) instead of skipping all remote I/O. Invalid buckets or credentials now fail at mount time. Made-with: Cursor * test(remote): add TestRemoteMountNoSync for -noSync mount and persisted mapping Made-with: Cursor * test(remote): assert no upfront metadata after -noSync mount After remote.mount -noSync, run fs.ls on the mount dir and assert empty listing so the test fails if pullMetadata was invoked eagerly. Made-with: Cursor * fix(remote): propagate non-ErrNotFound lookup errors in ensureMountDirectory Return lookupErr immediately for any LookupDirectoryEntry failure that is not filer_pb.ErrNotFound, so only the not-found case creates the entry and other lookup failures are reported to the caller. Made-with: Cursor * fix(remote): use errors.Is for ErrNotFound in ensureMountDirectory Replace fragile strings.Contains(lookupErr.Error(), ...) with errors.Is(lookupErr, filer_pb.ErrNotFound) before calling CreateEntry. Made-with: Cursor * fix(remote): use LookupEntry so ErrNotFound is recognised after gRPC Raw gRPC LookupDirectoryEntry returns a status error, not the sentinel, so errors.Is(lookupErr, filer_pb.ErrNotFound) was always false. Use filer_pb.LookupEntry which normalises not-found to ErrNotFound so the mount directory is created when missing. Made-with: Cursor * test(remote): ignore weed shell banner in TestRemoteMountNoSync fs.ls count Exclude master/filer and prompt lines from entry count so the assertion checks only actual fs.ls output for empty -noSync mount. Made-with: Cursor * fix(remote.mount): use 0755 for mount dir, document bucket-less early return Made-with: Cursor * feat(remote.mount): replace -noSync with -metadataStrategy=lazy|eager - Add -metadataStrategy flag (eager default, lazy skips upfront metadata pull) - Accept lazy/eager case-insensitively; reject invalid values with clear error - Rename TestRemoteMountNoSync to TestRemoteMountMetadataStrategyLazy - Add TestRemoteMountMetadataStrategyEager and TestRemoteMountMetadataStrategyInvalid Made-with: Cursor * fix(remote.mount): validate strategy and remote before creating mount directory Move strategy validation and validateMountRoot (lazy path) before ensureMountDirectory so that invalid strategies or bad bucket/credentials fail without leaving orphaned directory entries in the filer. * refactor(remote.mount): remove unused remote param from ensureMountDirectory The remote *RemoteStorageLocation parameter was left over from the old syncMetadata signature. Only remoteConf.Name is used inside the function. * doc(remote.mount): add TODO for HeadBucket-style validation validateMountRoot currently lists all buckets to verify one exists. Note the need for a targeted BucketExists method in the interface. * refactor(remote.mount): use MetadataStrategy type and constants Replace raw string comparisons with a MetadataStrategy type and MetadataStrategyEager/MetadataStrategyLazy constants for clarity and compile-time safety. * refactor(remote.mount): rename MetadataStrategy to MetadataCacheStrategy More precisely describes the purpose: controlling how metadata is cached from the remote, not metadata handling in general. * fix(remote.mount): remove validateMountRoot from lazy path Lazy mount's purpose is to skip remote I/O. Validating via ListBuckets contradicts that, especially on accounts with many buckets. Invalid buckets or credentials will surface on first lazy access instead. * fix(test): handle shell exit 0 in TestRemoteMountMetadataStrategyInvalid The weed shell process exits with code 0 even when individual commands fail — errors appear in stdout. Check output instead of requiring a non-nil error. * test(remote.mount): remove metadataStrategy shell integration tests These tests only verify string output from a shell process that always exits 0 — they cannot meaningfully validate eager vs lazy behavior without a real remote backend. --------- Co-authored-by: Chris Lu <chris.lu@gmail.com>
129 lines
3.9 KiB
Go
129 lines
3.9 KiB
Go
package shell
|
|
|
|
import (
|
|
"flag"
|
|
"fmt"
|
|
"io"
|
|
"path/filepath"
|
|
"regexp"
|
|
|
|
"github.com/seaweedfs/seaweedfs/weed/filer"
|
|
"github.com/seaweedfs/seaweedfs/weed/pb/remote_pb"
|
|
"github.com/seaweedfs/seaweedfs/weed/remote_storage"
|
|
"github.com/seaweedfs/seaweedfs/weed/util"
|
|
)
|
|
|
|
func init() {
|
|
Commands = append(Commands, &commandRemoteMountBuckets{})
|
|
}
|
|
|
|
type commandRemoteMountBuckets struct {
|
|
}
|
|
|
|
func (c *commandRemoteMountBuckets) Name() string {
|
|
return "remote.mount.buckets"
|
|
}
|
|
|
|
func (c *commandRemoteMountBuckets) Help() string {
|
|
return `mount all buckets in remote storage and pull its metadata
|
|
|
|
# assume a remote storage is configured to name "cloud1"
|
|
remote.configure -name=cloud1 -type=s3 -s3.access_key=xxx -s3.secret_key=yyy
|
|
|
|
# mount all buckets
|
|
remote.mount.buckets -remote=cloud1
|
|
|
|
# after mount, start a separate process to write updates to remote storage
|
|
weed filer.remote.gateway -filer=<filerHost>:<filerPort> -createBucketAt=cloud1
|
|
|
|
`
|
|
}
|
|
|
|
func (c *commandRemoteMountBuckets) HasTag(CommandTag) bool {
|
|
return false
|
|
}
|
|
|
|
func (c *commandRemoteMountBuckets) Do(args []string, commandEnv *CommandEnv, writer io.Writer) (err error) {
|
|
|
|
remoteMountBucketsCommand := flag.NewFlagSet(c.Name(), flag.ContinueOnError)
|
|
|
|
remote := remoteMountBucketsCommand.String("remote", "", "an already configured storage name")
|
|
bucketPattern := remoteMountBucketsCommand.String("bucketPattern", "", "match existing bucket name with wildcard characters '*' and '?'")
|
|
trimBucketSuffix := remoteMountBucketsCommand.Bool("trimBucketSuffix", true, "remote suffix auto generated by 'weed filer.remote.sync'")
|
|
apply := remoteMountBucketsCommand.Bool("apply", false, "apply the mount for listed buckets")
|
|
if err = remoteMountBucketsCommand.Parse(args); err != nil {
|
|
return nil
|
|
}
|
|
infoAboutSimulationMode(writer, *apply, "-apply")
|
|
|
|
if *remote == "" {
|
|
_, err = listExistingRemoteStorageMounts(commandEnv, writer)
|
|
return err
|
|
}
|
|
|
|
// find configuration for remote storage
|
|
remoteConf, err := filer.ReadRemoteStorageConf(commandEnv.option.GrpcDialOption, commandEnv.option.FilerAddress, *remote)
|
|
if err != nil {
|
|
return fmt.Errorf("find configuration for %s: %v", *remote, err)
|
|
}
|
|
|
|
// get storage client
|
|
remoteStorageClient, err := remote_storage.GetRemoteStorage(remoteConf)
|
|
if err != nil {
|
|
return fmt.Errorf("get storage client for %s: %v", *remote, err)
|
|
}
|
|
|
|
buckets, err := remoteStorageClient.ListBuckets()
|
|
if err != nil {
|
|
return fmt.Errorf("list buckets on %s: %v", *remote, err)
|
|
}
|
|
|
|
fillerBucketsPath, err := readFilerBucketsPath(commandEnv)
|
|
if err != nil {
|
|
return fmt.Errorf("read filer buckets path: %w", err)
|
|
}
|
|
|
|
hasSuffixPattern, _ := regexp.Compile(".+-[0-9][0-9][0-9][0-9]")
|
|
|
|
for _, bucket := range buckets {
|
|
if *bucketPattern != "" {
|
|
if matched, _ := filepath.Match(*bucketPattern, bucket.Name); !matched {
|
|
continue
|
|
}
|
|
}
|
|
|
|
fmt.Fprintf(writer, "bucket %s\n", bucket.Name)
|
|
localBucketName := bucket.Name
|
|
if *trimBucketSuffix {
|
|
if hasSuffixPattern.MatchString(localBucketName) {
|
|
localBucketName = localBucketName[:len(localBucketName)-5]
|
|
fmt.Fprintf(writer, " mount bucket %s as %s\n", bucket.Name, localBucketName)
|
|
}
|
|
}
|
|
if *apply {
|
|
|
|
dir := util.FullPath(fillerBucketsPath).Child(localBucketName)
|
|
remoteStorageLocation := &remote_pb.RemoteStorageLocation{
|
|
Name: *remote,
|
|
Bucket: bucket.Name,
|
|
Path: "/",
|
|
}
|
|
|
|
if err = ensureMountDirectory(commandEnv, string(dir), true, remoteConf); err != nil {
|
|
return fmt.Errorf("mount setup on %+v: %v", remoteStorageLocation, err)
|
|
}
|
|
if err = pullMetadata(commandEnv, writer, dir, remoteStorageLocation, dir, remoteConf); err != nil {
|
|
return fmt.Errorf("cache metadata on %+v: %v", remoteStorageLocation, err)
|
|
}
|
|
|
|
// store a mount configuration in filer
|
|
if err = filer.InsertMountMapping(commandEnv, string(dir), remoteStorageLocation); err != nil {
|
|
return fmt.Errorf("save mount mapping %s to %+v: %v", dir, remoteStorageLocation, err)
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|