generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 956
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CacheFSRuntime CRD definitions and controller implementations
Cachefs is a distributed filesystem that cache & accelerate any given POSIX directory with distributed cache. And ThinRuntime was implemented to make general storage like oss/nas easier to integrate with fluid, but thinruntime doesn't have the ability to cache & accelerate data access on thinruntime. So CacheFSRuntime is add as a general way to accelerate any storage from thinruntime or any given dir. Fixes: #3674 Signed-off-by: zyfjeff <[email protected]> Signed-off-by: Eryu Guan <[email protected]>
- Loading branch information
Showing
91 changed files
with
22,610 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,203 @@ | ||
| /* | ||
| Copyright 2023 The Fluid Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package v1alpha1 | ||
|
|
||
| import ( | ||
| corev1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| ) | ||
|
|
||
| const ( | ||
| CacheFSRuntimeKind = "CacheFSRuntime" | ||
| ) | ||
|
|
||
| // CacheFSRuntimeSpec defines the desired state of CacheFSRuntime | ||
| type CacheFSRuntimeSpec struct { | ||
| // INSERT ADDITIONAL SPEC FIELDS - desired state of cluster | ||
| // Important: Run "make" to regenerate code after modifying this file | ||
|
|
||
| // The version information that instructs fluid to orchestrate a particular version of CacheFS. | ||
| CacheFSVersion VersionSpec `json:"cachefsVersion,omitempty"` | ||
|
|
||
| // The component spec of CacheFS worker | ||
| Worker CacheFSCompSpec `json:"worker,omitempty"` | ||
|
|
||
| // Desired state for CacheFS Fuse | ||
| Fuse CacheFSFuseSpec `json:"fuse,omitempty"` | ||
|
|
||
| // Tiered storage used by CacheFS | ||
| TieredStore TieredStore `json:"tieredstore,omitempty"` | ||
|
|
||
| // Dataset used as CacheFS source | ||
| ImportDataset string `json:"importDataset,omitempty"` | ||
|
|
||
| // Configs of CacheFS, options for cachefs format sub-command, e.g. ["storage=oss", "capacity=100"] | ||
| Configs *[]string `json:"configs,omitempty"` | ||
|
|
||
| // The replicas of the worker, need to be specified | ||
| Replicas int32 `json:"replicas,omitempty"` | ||
|
|
||
| // Manage the user to run Cachefs Runtime | ||
| RunAs *User `json:"runAs,omitempty"` | ||
|
|
||
| // Volumes is the list of Kubernetes volumes that can be mounted by the cachefs runtime components and/or fuses. | ||
| // +optional | ||
| Volumes []corev1.Volume `json:"volumes,omitempty"` | ||
|
|
||
| // PodMetadata defines labels and annotations that will be propagated to CacheFs's pods. | ||
| // +optional | ||
| PodMetadata PodMetadata `json:"podMetadata,omitempty"` | ||
| } | ||
|
|
||
| // CacheFSCompSpec is a description of the CacheFS components | ||
| type CacheFSCompSpec struct { | ||
| // Replicas is the desired number of replicas of the given template. | ||
| // If unspecified, defaults to 1. | ||
| // +kubebuilder:validation:Minimum=1 | ||
| // replicas is the min replicas of dataset in the cluster | ||
| // +optional | ||
| Replicas int32 `json:"replicas,omitempty"` | ||
|
|
||
| // Ports used by CacheFS | ||
| // +optional | ||
| Ports []corev1.ContainerPort `json:"ports,omitempty"` | ||
|
|
||
| // Resources that will be requested by the CacheFS component. | ||
| // +optional | ||
| Resources corev1.ResourceRequirements `json:"resources,omitempty"` | ||
|
|
||
| // Options | ||
| Options map[string]string `json:"options,omitempty"` | ||
|
|
||
| // Environment variables that will be used by CacheFS component. | ||
| Env []corev1.EnvVar `json:"env,omitempty"` | ||
|
|
||
| // NodeSelector is a selector | ||
| // +optional | ||
| NodeSelector map[string]string `json:"nodeSelector,omitempty"` | ||
|
|
||
| // VolumeMounts specifies the volumes listed in ".spec.volumes" to mount into runtime component's filesystem. | ||
| // +optional | ||
| VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty"` | ||
|
|
||
| // PodMetadata defines labels and annotations that will be propagated to CacheFS's pods. | ||
| // +optional | ||
| PodMetadata PodMetadata `json:"podMetadata,omitempty"` | ||
|
|
||
| // Whether to use hostnetwork or not | ||
| // +kubebuilder:validation:Enum=HostNetwork;"";ContainerNetwork | ||
| // +optional | ||
| NetworkMode NetworkMode `json:"networkMode,omitempty"` | ||
| } | ||
|
|
||
| type CacheFSFuseSpec struct { | ||
| // Image for CacheFS fuse | ||
| Image string `json:"image,omitempty"` | ||
|
|
||
| // Image for CacheFS fuse | ||
| ImageTag string `json:"imageTag,omitempty"` | ||
|
|
||
| // One of the three policies: `Always`, `IfNotPresent`, `Never` | ||
| ImagePullPolicy string `json:"imagePullPolicy,omitempty"` | ||
|
|
||
| // Environment variables that will be used by CacheFS Fuse | ||
| Env []corev1.EnvVar `json:"env,omitempty"` | ||
|
|
||
| // Resources that will be requested by CacheFS Fuse. | ||
| Resources corev1.ResourceRequirements `json:"resources,omitempty"` | ||
|
|
||
| // Options mount options that fuse pod will use | ||
| // +optional | ||
| Options map[string]string `json:"options,omitempty"` | ||
|
|
||
| // If the fuse client should be deployed in global mode, | ||
| // otherwise the affinity should be considered | ||
| // +optional | ||
| Global bool `json:"global,omitempty"` | ||
|
|
||
| // 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 | ||
| // +optional | ||
| NodeSelector map[string]string `json:"nodeSelector,omitempty"` | ||
|
|
||
| // VolumeMounts specifies the volumes listed in ".spec.volumes" to mount into runtime component's filesystem. | ||
| // +optional | ||
| VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty"` | ||
|
|
||
| // CleanPolicy decides when to clean Cachefs Fuse pods. | ||
| // Currently Fluid supports two policies: OnDemand and OnRuntimeDeleted | ||
| // OnDemand cleans fuse pod once the fuse pod on some node is not needed | ||
| // OnRuntimeDeleted cleans fuse pod only when the cache runtime is deleted | ||
| // Defaults to OnRuntimeDeleted | ||
| // +optional | ||
| CleanPolicy FuseCleanPolicy `json:"cleanPolicy,omitempty"` | ||
|
|
||
| // PodMetadata defines labels and annotations that will be propagated to CacheFS's pods. | ||
| // +optional | ||
| PodMetadata PodMetadata `json:"podMetadata,omitempty"` | ||
|
|
||
| // Whether to use hostnetwork or not | ||
| // +kubebuilder:validation:Enum=HostNetwork;"";ContainerNetwork | ||
| // +optional | ||
| NetworkMode NetworkMode `json:"networkMode,omitempty"` | ||
| } | ||
|
|
||
| //+kubebuilder:object:root=true | ||
| //+kubebuilder:subresource:status | ||
| // +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.currentWorkerNumberScheduled,selectorpath=.status.selector | ||
| // +kubebuilder:printcolumn:name="Ready Workers",type="integer",JSONPath=`.status.workerNumberReady`,priority=10 | ||
| // +kubebuilder:printcolumn:name="Desired Workers",type="integer",JSONPath=`.status.desiredWorkerNumberScheduled`,priority=10 | ||
| // +kubebuilder:printcolumn:name="Worker Phase",type="string",JSONPath=`.status.workerPhase`,priority=0 | ||
| // +kubebuilder:printcolumn:name="Ready Fuses",type="integer",JSONPath=`.status.fuseNumberReady`,priority=10 | ||
| // +kubebuilder:printcolumn:name="Desired Fuses",type="integer",JSONPath=`.status.desiredFuseNumberScheduled`,priority=10 | ||
| // +kubebuilder:printcolumn:name="Fuse Phase",type="string",JSONPath=`.status.fusePhase`,priority=0 | ||
| // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=`.metadata.creationTimestamp`,priority=0 | ||
| // +kubebuilder:resource:scope=Namespaced | ||
| // +kubebuilder:resource:categories={fluid},shortName=cachefs | ||
| // +genclient | ||
|
|
||
| // CacheFSRuntime is the Schema for the cachefsruntimes API | ||
| type CacheFSRuntime struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ObjectMeta `json:"metadata,omitempty"` | ||
|
|
||
| Spec CacheFSRuntimeSpec `json:"spec,omitempty"` | ||
| Status RuntimeStatus `json:"status,omitempty"` | ||
| } | ||
|
|
||
| //+kubebuilder:object:root=true | ||
| // +kubebuilder:resource:scope=Namespaced | ||
|
|
||
| // CacheFSRuntimeList contains a list of CacheFSRuntime | ||
| type CacheFSRuntimeList struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ListMeta `json:"metadata,omitempty"` | ||
| Items []CacheFSRuntime `json:"items"` | ||
| } | ||
|
|
||
| func init() { | ||
| SchemeBuilder.Register(&CacheFSRuntime{}, &CacheFSRuntimeList{}) | ||
| } | ||
|
|
||
| // Replicas gets the replicas of runtime worker | ||
| func (c *CacheFSRuntime) Replicas() int32 { | ||
| return c.Spec.Replicas | ||
| } | ||
|
|
||
| func (c *CacheFSRuntime) GetStatus() *RuntimeStatus { | ||
| return &c.Status | ||
| } |
Oops, something went wrong.