operations

Documentation

Index

• type AlluxioFileUtils
  • func NewAlluxioFileUtils(podName string, containerName string, namespace string, log logr.Logger) AlluxioFileUtils
  • func (a AlluxioFileUtils) CachedState() (cached int64, err error)
  • func (a AlluxioFileUtils) CleanCache(path string, timeout int32) (err error)
  • func (a AlluxioFileUtils) Count(alluxioPath string) (fileCount int64, folderCount int64, total int64, err error)
  • func (a AlluxioFileUtils) Du(alluxioPath string) (ufs int64, cached int64, cachedPercentage string, err error)
  • func (a AlluxioFileUtils) ExecMountScripts() error
  • func (a AlluxioFileUtils) FindUnmountedAlluxioPaths(alluxioPaths []string) ([]string, error)
  • func (a AlluxioFileUtils) GetConf(key string) (value string, err error)
  • func (a AlluxioFileUtils) GetFileCount() (fileCount int64, err error)
  • func (a AlluxioFileUtils) GetMountedAlluxioPaths() ([]string, error)
  • func (a AlluxioFileUtils) IsMounted(alluxioPath string) (mounted bool, err error)
  • func (a AlluxioFileUtils) LoadMetaData(alluxioPath string, sync bool) (err error)
  • func (a AlluxioFileUtils) LoadMetadataWithoutTimeout(alluxioPath string) (err error)
  • func (a AlluxioFileUtils) MasterPodName() (masterPodName string, err error)
  • func (a AlluxioFileUtils) Mkdir(alluxioPath string) (err error)
  • func (a AlluxioFileUtils) Mount(alluxioPath string, ufsPath string, options map[string]string, readOnly bool, ...) (err error)
  • func (a AlluxioFileUtils) QueryMetaDataInfoIntoFile(key KeyOfMetaDataFile, filename string) (value string, err error)
  • func (a AlluxioFileUtils) Ready() (ready bool)
  • func (a AlluxioFileUtils) ReportCapacity() (report string, err error)
  • func (a AlluxioFileUtils) ReportMetrics() (metrics string, err error)
  • func (a AlluxioFileUtils) ReportSummary() (summary string, err error)
  • func (a AlluxioFileUtils) SyncLocalDir(path string) (err error)
  • func (a AlluxioFileUtils) UnMount(alluxioPath string) (err error)
• type KeyOfMetaDataFile

Types

type AlluxioFileUtils

type AlluxioFileUtils struct {
	// contains filtered or unexported fields
}

func NewAlluxioFileUtils

func NewAlluxioFileUtils(podName string, containerName string, namespace string, log logr.Logger) AlluxioFileUtils

func (AlluxioFileUtils) CachedState

func (a AlluxioFileUtils) CachedState() (cached int64, err error)

func (AlluxioFileUtils) CleanCache

func (a AlluxioFileUtils) CleanCache(path string, timeout int32) (err error)

clean cache with a preset timeout of 60s

func (AlluxioFileUtils) Count

func (a AlluxioFileUtils) Count(alluxioPath string) (fileCount int64, folderCount int64, total int64, err error)

The count of the Alluxio Filesystem

func (AlluxioFileUtils) Du

func (a AlluxioFileUtils) Du(alluxioPath string) (ufs int64, cached int64, cachedPercentage string, err error)

func (AlluxioFileUtils) ExecMountScripts

func (a AlluxioFileUtils) ExecMountScripts() error

func (AlluxioFileUtils) FindUnmountedAlluxioPaths

func (a AlluxioFileUtils) FindUnmountedAlluxioPaths(alluxioPaths []string) ([]string, error)

func (AlluxioFileUtils) GetConf

func (a AlluxioFileUtils) GetConf(key string) (value string, err error)

Get Conf info of the Alluxio Engine

func (AlluxioFileUtils) GetFileCount

func (a AlluxioFileUtils) GetFileCount() (fileCount int64, err error)

file count of the Alluxio Filesystem (except folder) use "alluxio fsadmin report metrics" for better performance

func (AlluxioFileUtils) GetMountedAlluxioPaths

func (a AlluxioFileUtils) GetMountedAlluxioPaths() ([]string, error)

func (AlluxioFileUtils) IsMounted

func (a AlluxioFileUtils) IsMounted(alluxioPath string) (mounted bool, err error)

func (AlluxioFileUtils) LoadMetaData

func (a AlluxioFileUtils) LoadMetaData(alluxioPath string, sync bool) (err error)

LoadMetaData loads the metadata.

func (AlluxioFileUtils) LoadMetadataWithoutTimeout

func (a AlluxioFileUtils) LoadMetadataWithoutTimeout(alluxioPath string) (err error)

Load the metadata without timeout

func (AlluxioFileUtils) MasterPodName

func (a AlluxioFileUtils) MasterPodName() (masterPodName string, err error)

func (AlluxioFileUtils) Mkdir

func (a AlluxioFileUtils) Mkdir(alluxioPath string) (err error)

func (AlluxioFileUtils) Mount

func (a AlluxioFileUtils) Mount(alluxioPath string,
	ufsPath string,
	options map[string]string,
	readOnly bool,
	shared bool) (err error)

func (AlluxioFileUtils) QueryMetaDataInfoIntoFile

func (a AlluxioFileUtils) QueryMetaDataInfoIntoFile(key KeyOfMetaDataFile, filename string) (value string, err error)

QueryMetaDataInfoIntoFile queries the metadata info file.

func (AlluxioFileUtils) Ready

func (a AlluxioFileUtils) Ready() (ready bool)

Check if the Alluxio is ready by running `alluxio fsadmin report` command

func (AlluxioFileUtils) ReportCapacity

func (a AlluxioFileUtils) ReportCapacity() (report string, err error)

ReportCapacity get alluxio capacity info by running `alluxio fsadmin report capacity` command

func (AlluxioFileUtils) ReportMetrics

func (a AlluxioFileUtils) ReportMetrics() (metrics string, err error)

ReportMetrics get alluxio metrics by running `alluxio fsadmin report metrics` command

func (AlluxioFileUtils) ReportSummary

func (a AlluxioFileUtils) ReportSummary() (summary string, err error)

Get summary info of the Alluxio Engine

func (AlluxioFileUtils) SyncLocalDir

func (a AlluxioFileUtils) SyncLocalDir(path string) (err error)

SyncLocalDir syncs local path by running command `du -sh <path>`. Under the circumstance where some NAS(e.g. NFS) is mounted on the `<path>`, the function will sync metadata of all files in the NAS. This is necessary for Alluxio to get consistent file metadata with UFS(i.e. NAS in this case).

func (AlluxioFileUtils) UnMount

func (a AlluxioFileUtils) UnMount(alluxioPath string) (err error)

type KeyOfMetaDataFile

type KeyOfMetaDataFile string

var (
	DatasetName KeyOfMetaDataFile = "dataset"
	Namespace   KeyOfMetaDataFile = "namespace"
	UfsTotal    KeyOfMetaDataFile = "ufstotal"
	FileNum     KeyOfMetaDataFile = "filenum"
)