api_doc.md

API Reference

data.fluid.io/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

• AlluxioRuntime
• DataBackup
• DataLoad
• Dataset
• GooseFSRuntime
• JindoRuntime
• JuiceFSRuntime

AlluxioRuntime

AlluxioRuntime is the Schema for the alluxioruntimes API

Field	Description
apiVersion string	data.fluid.io/v1alpha1
kind string	AlluxioRuntime
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec AlluxioRuntimeSpec	alluxioVersion VersionSpec The version information that instructs fluid to orchestrate a particular version of Alluxio. master AlluxioCompTemplateSpec The component spec of Alluxio master jobMaster AlluxioCompTemplateSpec The component spec of Alluxio job master worker AlluxioCompTemplateSpec The component spec of Alluxio worker jobWorker AlluxioCompTemplateSpec The component spec of Alluxio job Worker apiGateway AlluxioCompTemplateSpec The component spec of Alluxio API Gateway initUsers InitUsersSpec The spec of init users fuse AlluxioFuseSpec The component spec of Alluxio Fuse properties map[string]string Configurable properties for Alluxio system. Refer to Alluxio Configuration Properties for more info jvmOptions []string Options for JVM tieredstore TieredStore Tiered storage used by Alluxio data Data Management strategies for the dataset to which the runtime is bound replicas int32 The replicas of the worker, need to be specified runAs User Manage the user to run Alluxio Runtime disablePrometheus bool (Optional) Disable monitoring for Alluxio Runtime Prometheus is enabled by default hadoopConfig string (Optional) Name of the configMap used to support HDFS configurations when using HDFS as Alluxio’s UFS. The configMap must be in the same namespace with the AlluxioRuntime. The configMap should contain user-specific HDFS conf files in it. For now, only “hdfs-site.xml” and “core-site.xml” are supported. It must take the filename of the conf file as the key and content of the file as the value.
status RuntimeStatus

DataBackup

DataBackup is the Schema for the backup API

Field	Description
apiVersion string	data.fluid.io/v1alpha1
kind string	DataBackup
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec DataBackupSpec	dataset string Dataset defines the target dataset of the DataBackup backupPath string BackupPath defines the target path to save data of the DataBackup runAs User Manage the user to run Alluxio DataBackup
status DataBackupStatus

DataLoad

DataLoad is the Schema for the dataloads API

Field	Description
apiVersion string	data.fluid.io/v1alpha1
kind string	DataLoad
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec DataLoadSpec	dataset TargetDataset Dataset defines the target dataset of the DataLoad loadMetadata bool LoadMetadata specifies if the dataload job should load metadata target []TargetPath Target defines target paths that needs to be loaded options map[string]string Options specifies the extra dataload properties for runtime
status DataLoadStatus

Dataset

Dataset is the Schema for the datasets API

Field	Description
apiVersion string	data.fluid.io/v1alpha1
kind string	Dataset
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec DatasetSpec	mounts []Mount Mount Points to be mounted on Alluxio. owner User (Optional) The owner of the dataset nodeAffinity CacheableNodeAffinity (Optional) NodeAffinity defines constraints that limit what nodes this dataset can be cached to. This field influences the scheduling of pods that use the cached dataset. tolerations []Kubernetes core/v1.Toleration (Optional) If specified, the pod’s tolerations. accessModes []Kubernetes core/v1.PersistentVolumeAccessMode (Optional) AccessModes contains all ways the volume backing the PVC can be mounted runtimes []Runtime Runtimes for supporting dataset (e.g. AlluxioRuntime) placement PlacementMode (Optional) Manage switch for opening Multiple datasets single node deployment or not TODO(xieydd) In future, evaluate node resources and runtime resources to decide whether to turn them on dataRestoreLocation DataRestoreLocation (Optional) DataRestoreLocation is the location to load data of dataset been backuped
status DatasetStatus

GooseFSRuntime

GooseFSRuntime is the Schema for the goosefsruntimes API

Field	Description
apiVersion string	data.fluid.io/v1alpha1
kind string	GooseFSRuntime
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec GooseFSRuntimeSpec	goosefsVersion VersionSpec The version information that instructs fluid to orchestrate a particular version of GooseFS. master GooseFSCompTemplateSpec The component spec of GooseFS master jobMaster GooseFSCompTemplateSpec The component spec of GooseFS job master worker GooseFSCompTemplateSpec The component spec of GooseFS worker jobWorker GooseFSCompTemplateSpec The component spec of GooseFS job Worker apiGateway GooseFSCompTemplateSpec The component spec of GooseFS API Gateway initUsers InitUsersSpec The spec of init users fuse GooseFSFuseSpec The component spec of GooseFS Fuse properties map[string]string Configurable properties for the GOOSEFS component. Refer to GOOSEFS Configuration Properties for more info jvmOptions []string Options for JVM tieredstore TieredStore Tiered storage used by GooseFS data Data Management strategies for the dataset to which the runtime is bound replicas int32 The replicas of the worker, need to be specified runAs User Manage the user to run GooseFS Runtime GooseFS support POSIX-ACL and Apache Ranger to manager authorization TODO(chrisydxie@tencent.com) Support Apache Ranger. disablePrometheus bool (Optional) Disable monitoring for GooseFS Runtime Prometheus is enabled by default hadoopConfig string (Optional) Name of the configMap used to support HDFS configurations when using HDFS as GooseFS’s UFS. The configMap must be in the same namespace with the GooseFSRuntime. The configMap should contain user-specific HDFS conf files in it. For now, only “hdfs-site.xml” and “core-site.xml” are supported. It must take the filename of the conf file as the key and content of the file as the value.
status RuntimeStatus

JindoRuntime

JindoRuntime is the Schema for the jindoruntimes API

Field	Description
apiVersion string	data.fluid.io/v1alpha1
kind string	JindoRuntime
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec JindoRuntimeSpec	jindoVersion VersionSpec The version information that instructs fluid to orchestrate a particular version of Jindo. master JindoCompTemplateSpec The component spec of Jindo master worker JindoCompTemplateSpec The component spec of Jindo worker fuse JindoFuseSpec The component spec of Jindo Fuse properties map[string]string Configurable properties for Jindo system. tieredstore TieredStore Tiered storage used by Jindo replicas int32 The replicas of the worker, need to be specified runAs User Manage the user to run Jindo Runtime user string hadoopConfig string (Optional) Name of the configMap used to support HDFS configurations when using HDFS as Jindo’s UFS. The configMap must be in the same namespace with the JindoRuntime. The configMap should contain user-specific HDFS conf files in it. For now, only “hdfs-site.xml” and “core-site.xml” are supported. It must take the filename of the conf file as the key and content of the file as the value. secret string labels map[string]string (Optional) Labels will be added on all the JindoFS pods. logConfig map[string]string (Optional) networkmode NetworkMode (Optional) Whether to use hostnetwork or not
status RuntimeStatus

JuiceFSRuntime

JuiceFSRuntime is the Schema for the juicefsruntimes API

Field	Description
apiVersion string	data.fluid.io/v1alpha1
kind string	JuiceFSRuntime
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec JuiceFSRuntimeSpec	juicefsVersion VersionSpec The version information that instructs fluid to orchestrate a particular version of JuiceFS. initUsers InitUsersSpec The spec of init users master JuiceFSCompTemplateSpec The component spec of JuiceFS master worker JuiceFSCompTemplateSpec The component spec of JuiceFS worker jobWorker JuiceFSCompTemplateSpec The component spec of JuiceFS job Worker fuse JuiceFSFuseSpec Desired state for JuiceFS Fuse tieredstore TieredStore Tiered storage used by JuiceFS replicas int32 The replicas of the worker, need to be specified runAs User Manage the user to run Juicefs Runtime disablePrometheus bool (Optional) Disable monitoring for JuiceFS Runtime Prometheus is enabled by default
status RuntimeStatus

APIGatewayStatus

(Appears on: RuntimeStatus)

API Gateway

Field	Description
endpoint string	Endpoint for accessing

AlluxioCompTemplateSpec

(Appears on: AlluxioRuntimeSpec)

AlluxioCompTemplateSpec is a description of the Alluxio commponents

Field	Description
replicas int32	(Optional) Replicas is the desired number of replicas of the given template. If unspecified, defaults to 1. replicas is the min replicas of dataset in the cluster
jvmOptions []string	Options for JVM
properties map[string]string	(Optional) Configurable properties for the Alluxio component. Refer to Alluxio Configuration Properties for more info
ports map[string]int	(Optional) Ports used by Alluxio(e.g. rpc: 19998 for master)
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources that will be requested by the Alluxio component. Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
env map[string]string	Environment variables that will be used by Alluxio component.
enabled bool	(Optional) Enabled or Disabled for the components. For now, only API Gateway is enabled or disabled.
nodeSelector map[string]string	(Optional) NodeSelector is a selector which must be true for the master to fit on a node

AlluxioFuseSpec

(Appears on: AlluxioRuntimeSpec)

AlluxioFuseSpec is a description of the Alluxio Fuse

Field	Description
image string	Image for Alluxio Fuse(e.g. alluxio/alluxio-fuse)
imageTag string	Image Tag for Alluxio Fuse(e.g. 2.3.0-SNAPSHOT)
imagePullPolicy string	One of the three policies: Always, IfNotPresent, Never
jvmOptions []string	Options for JVM
properties map[string]string	Configurable properties for Alluxio System. Refer to Alluxio Configuration Properties for more info
env map[string]string	Environment variables that will be used by Alluxio Fuse
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources that will be requested by Alluxio Fuse. Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
args []string	Arguments that will be passed to Alluxio Fuse
global bool	(Optional) If the fuse client should be deployed in global mode, otherwise the affinity should be considered
nodeSelector map[string]string	(Optional) NodeSelector is a selector which must be true for the fuse client to fit on a node, this option only effect when global is enabled
cleanPolicy FuseCleanPolicy	(Optional) CleanPolicy decides when to clean Alluxio Fuse pods. Currently Fluid supports two policies: OnDemand and OnRuntimeDeleted OnDemand cleans fuse pod once th fuse pod on some node is not needed OnRuntimeDeleted cleans fuse pod only when the cache runtime is deleted Defaults to OnRuntimeDeleted

AlluxioRuntimeRole (string alias)

AlluxioRuntimeSpec

(Appears on: AlluxioRuntime)

AlluxioRuntimeSpec defines the desired state of AlluxioRuntime

Field	Description
alluxioVersion VersionSpec	The version information that instructs fluid to orchestrate a particular version of Alluxio.
master AlluxioCompTemplateSpec	The component spec of Alluxio master
jobMaster AlluxioCompTemplateSpec	The component spec of Alluxio job master
worker AlluxioCompTemplateSpec	The component spec of Alluxio worker
jobWorker AlluxioCompTemplateSpec	The component spec of Alluxio job Worker
apiGateway AlluxioCompTemplateSpec	The component spec of Alluxio API Gateway
initUsers InitUsersSpec	The spec of init users
fuse AlluxioFuseSpec	The component spec of Alluxio Fuse
properties map[string]string	Configurable properties for Alluxio system. Refer to Alluxio Configuration Properties for more info
jvmOptions []string	Options for JVM
tieredstore TieredStore	Tiered storage used by Alluxio
data Data	Management strategies for the dataset to which the runtime is bound
replicas int32	The replicas of the worker, need to be specified
runAs User	Manage the user to run Alluxio Runtime
disablePrometheus bool	(Optional) Disable monitoring for Alluxio Runtime Prometheus is enabled by default
hadoopConfig string	(Optional) Name of the configMap used to support HDFS configurations when using HDFS as Alluxio’s UFS. The configMap must be in the same namespace with the AlluxioRuntime. The configMap should contain user-specific HDFS conf files in it. For now, only “hdfs-site.xml” and “core-site.xml” are supported. It must take the filename of the conf file as the key and content of the file as the value.

BackupLocation

(Appears on: DataBackupStatus)

BackupLocation describes the final backup location of DataBackup

Field	Description
path string	Path describes the path of backup, in the form of local:///absolutePath or pvc:///subpath
nodeName string	NodeName describes the nodeName of backup if Path is in the form of local://subpath

CacheableNodeAffinity

(Appears on: DatasetSpec)

CacheableNodeAffinity defines constraints that limit what nodes this dataset can be cached to.

Field	Description
required Kubernetes core/v1.NodeSelector	Required specifies hard node constraints that must be met.

Condition

(Appears on: DataBackupStatus, DataLoadStatus)

Condition explains the transitions on phase

Field	Description
type common.ConditionType	Type of condition, either Complete or Failed
status Kubernetes core/v1.ConditionStatus	Status of the condition, one of True, False or Unknown
reason string	Reason for the condition’s last transition
message string	Message is a human-readable message indicating details about the transition
lastProbeTime Kubernetes meta/v1.Time	LastProbeTime describes last time this condition was updated.
lastTransitionTime Kubernetes meta/v1.Time	LastTransitionTime describes last time the condition transitioned from one status to another.

Data

(Appears on: AlluxioRuntimeSpec, GooseFSRuntimeSpec)

Data management strategies

Field	Description
replicas int32	(Optional) The copies of the dataset
pin bool	(Optional) Pin the dataset or not. Refer to Alluxio User-CLI pin

DataBackupSpec

(Appears on: DataBackup)

DataBackupSpec defines the desired state of DataBackup

Field	Description
dataset string	Dataset defines the target dataset of the DataBackup
backupPath string	BackupPath defines the target path to save data of the DataBackup
runAs User	Manage the user to run Alluxio DataBackup

DataBackupStatus

(Appears on: DataBackup)

DataBackupStatus defines the observed state of DataBackup

Field	Description
phase common.Phase	Phase describes current phase of DataBackup
backupLocation BackupLocation	BackupLocation tell user the location to save data of the DataBackup
duration string	Duration tell user how much time was spent to backup
conditions []Condition	Conditions consists of transition information on DataBackup’s Phase

DataLoadSpec

(Appears on: DataLoad)

DataLoadSpec defines the desired state of DataLoad

Field	Description
dataset TargetDataset	Dataset defines the target dataset of the DataLoad
loadMetadata bool	LoadMetadata specifies if the dataload job should load metadata
target []TargetPath	Target defines target paths that needs to be loaded
options map[string]string	Options specifies the extra dataload properties for runtime

DataLoadStatus

(Appears on: DataLoad)

DataLoadStatus defines the observed state of DataLoad

Field	Description
phase common.Phase	Phase describes current phase of DataLoad
conditions []Condition	Conditions consists of transition information on DataLoad’s Phase
duration string	Duration tell user how much time was spent to load the data

DataRestoreLocation

(Appears on: DatasetSpec)

DataRestoreLocation describes the spec restore location of Dataset

Field	Description
path string	(Optional) Path describes the path of restore, in the form of local://subpath or pvc:///subpath
nodeName string	(Optional) NodeName describes the nodeName of restore if Path is in the form of local://subpath

DatasetCondition

(Appears on: DatasetStatus)

Condition describes the state of the cache at a certain point.

Field	Description
type DatasetConditionType	Type of cache condition.
status Kubernetes core/v1.ConditionStatus	Status of the condition, one of True, False, Unknown.
reason string	The reason for the condition’s last transition.
message string	A human readable message indicating details about the transition.
lastUpdateTime Kubernetes meta/v1.Time	The last time this condition was updated.
lastTransitionTime Kubernetes meta/v1.Time	Last time the condition transitioned from one status to another.

DatasetSpec

(Appears on: Dataset)

DatasetSpec defines the desired state of Dataset

Field	Description
mounts []Mount	Mount Points to be mounted on Alluxio.
owner User	(Optional) The owner of the dataset
nodeAffinity CacheableNodeAffinity	(Optional) NodeAffinity defines constraints that limit what nodes this dataset can be cached to. This field influences the scheduling of pods that use the cached dataset.
tolerations []Kubernetes core/v1.Toleration	(Optional) If specified, the pod’s tolerations.
accessModes []Kubernetes core/v1.PersistentVolumeAccessMode	(Optional) AccessModes contains all ways the volume backing the PVC can be mounted
runtimes []Runtime	Runtimes for supporting dataset (e.g. AlluxioRuntime)
placement PlacementMode	(Optional) Manage switch for opening Multiple datasets single node deployment or not TODO(xieydd) In future, evaluate node resources and runtime resources to decide whether to turn them on
dataRestoreLocation DataRestoreLocation	(Optional) DataRestoreLocation is the location to load data of dataset been backuped

DatasetStatus

(Appears on: Dataset)

DatasetStatus defines the observed state of Dataset

Field	Description
mounts []Mount	the info of mount points have been mounted
ufsTotal string	Total in GB of dataset in the cluster
phase DatasetPhase	Dataset Phase. One of the four phases: Pending, Bound, NotBound and Failed
runtimes []Runtime	Runtimes for supporting dataset
conditions []DatasetCondition	Conditions is an array of current observed conditions.
cacheStates common.CacheStateList	CacheStatus represents the total resources of the dataset.
hcfs HCFSStatus	HCFSStatus represents hcfs info
fileNum string	FileNum represents the file numbers of the dataset
dataLoadRef string	DataLoadRef specifies the running DataLoad job that targets this Dataset. This is mainly used as a lock to prevent concurrent DataLoad jobs.
dataBackupRef string	DataBackupRef specifies the running Backup job that targets this Dataset. This is mainly used as a lock to prevent concurrent DataBackup jobs.

EncryptOption

(Appears on: Mount)

Field	Description
name string	The name of encryptOption
valueFrom EncryptOptionSource	(Optional) The valueFrom of encryptOption

EncryptOptionSource

(Appears on: EncryptOption)

Field	Description
secretKeyRef SecretKeySelector	(Optional) The encryptInfo obtained from secret

FuseCleanPolicy (string alias)

(Appears on: AlluxioFuseSpec, GooseFSFuseSpec, JindoFuseSpec, JuiceFSFuseSpec)

GooseFSCompTemplateSpec

(Appears on: GooseFSRuntimeSpec)

GooseFSCompTemplateSpec is a description of the GooseFS commponents

Field	Description
replicas int32	(Optional) Replicas is the desired number of replicas of the given template. If unspecified, defaults to 1. replicas is the min replicas of dataset in the cluster
jvmOptions []string	Options for JVM
properties map[string]string	(Optional) Configurable properties for the GOOSEFS component. Refer to GOOSEFS Configuration Properties for more info
ports map[string]int	(Optional) Ports used by GooseFS(e.g. rpc: 19998 for master)
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources that will be requested by the GooseFS component. Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
env map[string]string	Environment variables that will be used by GooseFS component.
enabled bool	(Optional) Enabled or Disabled for the components. For now, only API Gateway is enabled or disabled.
nodeSelector map[string]string	(Optional) NodeSelector is a selector which must be true for the master to fit on a node
annotations map[string]string	(Optional) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

GooseFSFuseSpec

(Appears on: GooseFSRuntimeSpec)

GooseFSFuseSpec is a description of the GooseFS Fuse

Field	Description
image string	Image for GooseFS Fuse(e.g. goosefs/goosefs-fuse)
imageTag string	Image Tag for GooseFS Fuse(e.g. v1.0.1)
imagePullPolicy string	One of the three policies: Always, IfNotPresent, Never
jvmOptions []string	Options for JVM
properties map[string]string	Configurable properties for the GOOSEFS component. Refer to GOOSEFS Configuration Properties for more info
env map[string]string	Environment variables that will be used by GooseFS Fuse
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources that will be requested by GooseFS Fuse. Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
args []string	Arguments that will be passed to GooseFS Fuse
global bool	(Optional) If the fuse client should be deployed in global mode, otherwise the affinity should be considered
nodeSelector map[string]string	(Optional) NodeSelector is a selector which must be true for the fuse client to fit on a node, this option only effect when global is enabled
cleanPolicy FuseCleanPolicy	(Optional) CleanPolicy decides when to clean GooseFS Fuse pods. Currently Fluid supports two policies: OnDemand and OnRuntimeDeleted OnDemand cleans fuse pod once th fuse pod on some node is not needed OnRuntimeDeleted cleans fuse pod only when the cache runtime is deleted Defaults to OnRuntimeDeleted
annotations map[string]string	(Optional) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

GooseFSRuntimeSpec

(Appears on: GooseFSRuntime)

GooseFSRuntimeSpec defines the desired state of GooseFSRuntime

Field	Description
goosefsVersion VersionSpec	The version information that instructs fluid to orchestrate a particular version of GooseFS.
master GooseFSCompTemplateSpec	The component spec of GooseFS master
jobMaster GooseFSCompTemplateSpec	The component spec of GooseFS job master
worker GooseFSCompTemplateSpec	The component spec of GooseFS worker
jobWorker GooseFSCompTemplateSpec	The component spec of GooseFS job Worker
apiGateway GooseFSCompTemplateSpec	The component spec of GooseFS API Gateway
initUsers InitUsersSpec	The spec of init users
fuse GooseFSFuseSpec	The component spec of GooseFS Fuse
properties map[string]string	Configurable properties for the GOOSEFS component. Refer to GOOSEFS Configuration Properties for more info
jvmOptions []string	Options for JVM
tieredstore TieredStore	Tiered storage used by GooseFS
data Data	Management strategies for the dataset to which the runtime is bound
replicas int32	The replicas of the worker, need to be specified
runAs User	Manage the user to run GooseFS Runtime GooseFS support POSIX-ACL and Apache Ranger to manager authorization TODO(chrisydxie@tencent.com) Support Apache Ranger.
disablePrometheus bool	(Optional) Disable monitoring for GooseFS Runtime Prometheus is enabled by default
hadoopConfig string	(Optional) Name of the configMap used to support HDFS configurations when using HDFS as GooseFS’s UFS. The configMap must be in the same namespace with the GooseFSRuntime. The configMap should contain user-specific HDFS conf files in it. For now, only “hdfs-site.xml” and “core-site.xml” are supported. It must take the filename of the conf file as the key and content of the file as the value.

HCFSStatus

(Appears on: DatasetStatus)

HCFS Endpoint info

Field	Description
endpoint string	Endpoint for accessing
underlayerFileSystemVersion string	Underlayer HCFS Compatible Version

InitUsersSpec

(Appears on: AlluxioRuntimeSpec, GooseFSRuntimeSpec, JuiceFSRuntimeSpec)

InitUsersSpec is a description of the initialize the users for runtime

Field	Description
image string	Image for initialize the users for runtime(e.g. alluxio/alluxio-User init)
imageTag string	Image Tag for initialize the users for runtime(e.g. 2.3.0-SNAPSHOT)
imagePullPolicy string	One of the three policies: Always, IfNotPresent, Never
env map[string]string	Environment variables that will be used by initialize the users for runtime
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources that will be requested by initialize the users for runtime. Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.

JindoCompTemplateSpec

(Appears on: JindoRuntimeSpec)

JindoCompTemplateSpec is a description of the Jindo commponents

Field	Description
replicas int32	(Optional) Replicas is the desired number of replicas of the given template. If unspecified, defaults to 1. replicas is the min replicas of dataset in the cluster
properties map[string]string	(Optional) Configurable properties for the Jindo component.
ports map[string]int	(Optional)
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources that will be requested by the Jindo component. Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
env map[string]string	Environment variables that will be used by Jindo component.
nodeSelector map[string]string	(Optional) NodeSelector is a selector which must be true for the master to fit on a node
tolerations []Kubernetes core/v1.Toleration	(Optional) If specified, the pod’s tolerations.
labels map[string]string	(Optional) Labels will be added on all the JindoFS Master or Worker pods. Any label already existed will be overriden

JindoFuseSpec

(Appears on: JindoRuntimeSpec)

JindoFuseSpec is a description of the Jindo Fuse

Field	Description
image string	Image for Jindo Fuse(e.g. jindo/jindo-fuse)
imageTag string	Image Tag for Jindo Fuse(e.g. 2.3.0-SNAPSHOT)
imagePullPolicy string	One of the three policies: Always, IfNotPresent, Never
properties map[string]string	Configurable properties for Jindo System.
env map[string]string	Environment variables that will be used by Jindo Fuse
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources that will be requested by Jindo Fuse. Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
args []string	Arguments that will be passed to Jindo Fuse
global bool	(Optional) If the fuse client should be deployed in global mode, otherwise the affinity should be considered
nodeSelector map[string]string	(Optional) NodeSelector is a selector which must be true for the fuse client to fit on a node, this option only effect when global is enabled
tolerations []Kubernetes core/v1.Toleration	(Optional) If specified, the pod’s tolerations.
labels map[string]string	(Optional) Labels will be added on all the JindoFS Fuse pods. Any label already existed will be overriden
cleanPolicy FuseCleanPolicy	(Optional) CleanPolicy decides when to clean JindoFS Fuse pods. Currently Fluid supports two policies: OnDemand and OnRuntimeDeleted OnDemand cleans fuse pod once th fuse pod on some node is not needed OnRuntimeDeleted cleans fuse pod only when the cache runtime is deleted Defaults to OnRuntimeDeleted

JindoRuntimeSpec

(Appears on: JindoRuntime)

JindoRuntimeSpec defines the desired state of JindoRuntime

Field	Description
jindoVersion VersionSpec	The version information that instructs fluid to orchestrate a particular version of Jindo.
master JindoCompTemplateSpec	The component spec of Jindo master
worker JindoCompTemplateSpec	The component spec of Jindo worker
fuse JindoFuseSpec	The component spec of Jindo Fuse
properties map[string]string	Configurable properties for Jindo system.
tieredstore TieredStore	Tiered storage used by Jindo
replicas int32	The replicas of the worker, need to be specified
runAs User	Manage the user to run Jindo Runtime
user string
hadoopConfig string	(Optional) Name of the configMap used to support HDFS configurations when using HDFS as Jindo’s UFS. The configMap must be in the same namespace with the JindoRuntime. The configMap should contain user-specific HDFS conf files in it. For now, only “hdfs-site.xml” and “core-site.xml” are supported. It must take the filename of the conf file as the key and content of the file as the value.
secret string
labels map[string]string	(Optional) Labels will be added on all the JindoFS pods.
logConfig map[string]string	(Optional)
networkmode NetworkMode	(Optional) Whether to use hostnetwork or not

JuiceFSCompTemplateSpec

(Appears on: JuiceFSRuntimeSpec)

JuiceFSCompTemplateSpec is a description of the JuiceFS components

Field	Description
replicas int32	(Optional) Replicas is the desired number of replicas of the given template. If unspecified, defaults to 1. replicas is the min replicas of dataset in the cluster
ports []Kubernetes core/v1.ContainerPort	(Optional) Ports used by JuiceFS
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources that will be requested by the JuiceFS component.
env []Kubernetes core/v1.EnvVar	Environment variables that will be used by JuiceFS component.
enabled bool	(Optional) Enabled or Disabled for the components.
nodeSelector map[string]string	(Optional) NodeSelector is a selector

JuiceFSFuseSpec

(Appears on: JuiceFSRuntimeSpec)

Field	Description
image string	Image for JuiceFS fuse
image_tag string	Image for JuiceFS fuse
image_pull_policy string	One of the three policies: Always, IfNotPresent, Never
env []Kubernetes core/v1.EnvVar	Environment variables that will be used by JuiceFS Fuse
resources Kubernetes core/v1.ResourceRequirements	Resources that will be requested by JuiceFS Fuse.
global bool	(Optional) If the fuse client should be deployed in global mode, otherwise the affinity should be considered
node_selector map[string]string	(Optional) NodeSelector is a selector which must be true for the fuse client to fit on a node, this option only effect when global is enabled
cleanPolicy FuseCleanPolicy	(Optional) CleanPolicy decides when to clean Juicefs Fuse pods. Currently Fluid supports two policies: OnDemand and OnRuntimeDeleted OnDemand cleans fuse pod once th fuse pod on some node is not needed OnRuntimeDeleted cleans fuse pod only when the cache runtime is deleted Defaults to OnDemand

JuiceFSRuntimeSpec

(Appears on: JuiceFSRuntime)

JuiceFSRuntimeSpec defines the desired state of JuiceFSRuntime

Field	Description
juicefsVersion VersionSpec	The version information that instructs fluid to orchestrate a particular version of JuiceFS.
initUsers InitUsersSpec	The spec of init users
master JuiceFSCompTemplateSpec	The component spec of JuiceFS master
worker JuiceFSCompTemplateSpec	The component spec of JuiceFS worker
jobWorker JuiceFSCompTemplateSpec	The component spec of JuiceFS job Worker
fuse JuiceFSFuseSpec	Desired state for JuiceFS Fuse
tieredstore TieredStore	Tiered storage used by JuiceFS
replicas int32	The replicas of the worker, need to be specified
runAs User	Manage the user to run Juicefs Runtime
disablePrometheus bool	(Optional) Disable monitoring for JuiceFS Runtime Prometheus is enabled by default

Level

(Appears on: TieredStore)

Level describes configurations a tier needs.
Refer to Configuring Tiered Storage for more info

Field	Description
mediumtype common.MediumType	Medium Type of the tier. One of the three types: MEM, SSD, HDD
path string	File paths to be used for the tier. Multiple paths are supported. Multiple paths should be separated with comma. For example: “/mnt/cache1,/mnt/cache2”.
quota Kubernetes resource.Quantity	(Optional) Quota for the whole tier. (e.g. 100Gi) Please note that if there’re multiple paths used for this tierstore, the quota will be equally divided into these paths. If you’d like to set quota for each, path, see QuotaList for more information.
quotaList string	(Optional) QuotaList are quotas used to set quota on multiple paths. Quotas should be separated with comma. Quotas in this list will be set to paths with the same order in Path. For example, with Path defined with “/mnt/cache1,/mnt/cache2” and QuotaList set to “100Gi, 50Gi”, then we get 100GiB cache storage under “/mnt/cache1” and 50GiB under “/mnt/cache2”. Also note that num of quotas must be consistent with the num of paths defined in Path.
high string	Ratio of high watermark of the tier (e.g. 0.9)
low string	Ratio of low watermark of the tier (e.g. 0.7)

Mount

(Appears on: DatasetSpec, DatasetStatus)

Mount describes a mounting.
Refer to Alluxio Storage Integrations for more info

Field	Description
mountPoint string	MountPoint is the mount point of source.
options map[string]string	(Optional) The Mount Options. Refer to Mount Options. The option has Prefix ‘fs.’ And you can Learn more from The Storage Integrations
name string	The name of mount
path string	(Optional) The path of mount, if not set will be /{Name}
readOnly bool	(Optional) Optional: Defaults to false (read-write).
shared bool	(Optional) Optional: Defaults to false (shared).
encryptOptions []EncryptOption	(Optional) The secret information

NetworkMode (string alias)

(Appears on: JindoRuntimeSpec)

PlacementMode (string alias)

(Appears on: DatasetSpec)

Runtime

(Appears on: DatasetSpec, DatasetStatus)

Runtime describes a runtime to be used to support dataset

Field	Description
name string	Name of the runtime object
namespace string	Namespace of the runtime object
category common.Category	Category the runtime object belongs to (e.g. Accelerate)
type string	Runtime object’s type (e.g. Alluxio)
masterReplicas int32	Runtime master replicas

RuntimeCondition

(Appears on: RuntimeStatus)

Condition describes the state of the cache at a certain point.

Field	Description
type RuntimeConditionType	Type of cache condition.
status Kubernetes core/v1.ConditionStatus	Status of the condition, one of True, False, Unknown.
reason string	The reason for the condition’s last transition.
message string	A human readable message indicating details about the transition.
lastProbeTime Kubernetes meta/v1.Time	The last time this condition was updated.
lastTransitionTime Kubernetes meta/v1.Time	Last time the condition transitioned from one status to another.

RuntimeStatus

(Appears on: AlluxioRuntime, GooseFSRuntime, JindoRuntime, JuiceFSRuntime)

RuntimeStatus defines the observed state of Runtime

Field	Description
valueFile string	config map used to set configurations
masterPhase RuntimePhase	MasterPhase is the master running phase
masterReason string	Reason for Master’s condition transition
workerPhase RuntimePhase	WorkerPhase is the worker running phase
workerReason string	Reason for Worker’s condition transition
desiredWorkerNumberScheduled int32	The total number of nodes that should be running the runtime worker pod (including nodes correctly running the runtime worker pod).
currentWorkerNumberScheduled int32	The total number of nodes that can be running the runtime worker pod (including nodes correctly running the runtime worker pod).
workerNumberReady int32	The number of nodes that should be running the runtime worker pod and have one or more of the runtime worker pod running and ready.
workerNumberAvailable int32	(Optional) The number of nodes that should be running the runtime worker pod and have one or more of the runtime worker pod running and available (ready for at least spec.minReadySeconds)
workerNumberUnavailable int32	(Optional) The number of nodes that should be running the runtime worker pod and have none of the runtime worker pod running and available (ready for at least spec.minReadySeconds)
desiredMasterNumberScheduled int32	The total number of nodes that should be running the runtime pod (including nodes correctly running the runtime master pod).
currentMasterNumberScheduled int32	The total number of nodes that should be running the runtime pod (including nodes correctly running the runtime master pod).
masterNumberReady int32	The number of nodes that should be running the runtime worker pod and have zero or more of the runtime master pod running and ready.
fusePhase RuntimePhase	FusePhase is the Fuse running phase
fuseReason string	Reason for the condition’s last transition.
currentFuseNumberScheduled int32	The total number of nodes that can be running the runtime Fuse pod (including nodes correctly running the runtime Fuse pod).
desiredFuseNumberScheduled int32	The total number of nodes that should be running the runtime Fuse pod (including nodes correctly running the runtime Fuse pod).
fuseNumberReady int32	The number of nodes that should be running the runtime Fuse pod and have one or more of the runtime Fuse pod running and ready.
fuseNumberUnavailable int32	(Optional) The number of nodes that should be running the runtime fuse pod and have none of the runtime fuse pod running and available (ready for at least spec.minReadySeconds)
fuseNumberAvailable int32	(Optional) The number of nodes that should be running the runtime Fuse pod and have one or more of the runtime Fuse pod running and available (ready for at least spec.minReadySeconds)
setupDuration string	Duration tell user how much time was spent to setup the runtime
conditions []RuntimeCondition	Represents the latest available observations of a ddc runtime’s current state.
cacheStates common.CacheStateList	CacheStatus represents the total resources of the dataset.
selector string	Selector is used for auto-scaling
apiGateway APIGatewayStatus	APIGatewayStatus represents rest api gateway status

SecretKeySelector

(Appears on: EncryptOptionSource)

Field	Description
name string	The name of required secret
key string	(Optional) The required key in the secret

TargetDataset

(Appears on: DataLoadSpec)

TargetDataset defines the target dataset of the DataLoad

Field	Description
name string	Name defines name of the target dataset
namespace string	Namespace defines namespace of the target dataset

TargetPath

(Appears on: DataLoadSpec)

TargetPath defines the target path of the DataLoad

Field	Description
path string	Path defines path to be load
replicas int32	Replicas defines how many replicas will be loaded

TieredStore

(Appears on: AlluxioRuntimeSpec, GooseFSRuntimeSpec, JindoRuntimeSpec, JuiceFSRuntimeSpec)

TieredStore is a description of the tiered store

Field	Description
levels []Level	configurations for multiple tiers

User

(Appears on: AlluxioRuntimeSpec, DataBackupSpec, DatasetSpec, GooseFSRuntimeSpec, JindoRuntimeSpec, JuiceFSRuntimeSpec)

User explains the user and group to run a Container

Field	Description
uid int64	The uid to run the alluxio runtime
gid int64	The gid to run the alluxio runtime
user string	The user name to run the alluxio runtime
group string	The group name to run the alluxio runtime

VersionSpec

(Appears on: AlluxioRuntimeSpec, GooseFSRuntimeSpec, JindoRuntimeSpec, JuiceFSRuntimeSpec)

VersionSpec represents the settings for the version that fluid is orchestrating.

Field	Description
image string	Image (e.g. alluxio/alluxio)
imageTag string	Image tag (e.g. 2.3.0-SNAPSHOT)
imagePullPolicy string	One of the three policies: Always, IfNotPresent, Never

---

Generated with gen-crd-api-reference-docs on git commit 4dd8c8ee.