Skip to content

feat: File persistence definition and implementation #4742

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
lokeshrangineni merged 13 commits into from
Nov 8, 2024
Merged

feat: File persistence definition and implementation #4742

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d64da1a
File persistence definition and implementation
dmartinol Nov 6, 2024
08b1011
removed optional and default markers
dmartinol Nov 6, 2024
9b07506
removed global cfg variable
dmartinol Nov 6, 2024
db3c5c5
reviewed ApplyDefaultsToStatus
dmartinol Nov 6, 2024
74c518c
extended checks in ApplyDefaultsToStatus
dmartinol Nov 6, 2024
da6a84f
removed var error
dmartinol Nov 6, 2024
bce16ca
added IsValidOfflineStoreFilePersistenceType to the API definitions
dmartinol Nov 7, 2024
15c595b
Merge branch 'feast-dev:master' into persistence_file
dmartinol Nov 7, 2024
251538d
moved IsValidOfflineStoreFilePersistenceType to services package and …
dmartinol Nov 7, 2024
ca09666
renamed isValidOfflineStoreFilePersistenceType to checkOfflineStoreFi…
dmartinol Nov 7, 2024
f1134ac
adding controller tests for ephemeral stores
dmartinol Nov 7, 2024
8677162
using slices package
dmartinol Nov 7, 2024
3b76db9
Merge branch 'feast-dev:master' into persistence_file
dmartinol Nov 8, 2024
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
Prev Previous commit
Next Next commit
moved IsValidOfflineStoreFilePersistenceType to services package and … 
…use it in deploy flow

Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
  • Loading branch information
@dmartinol
dmartinol committed Nov 7, 2024
commit 251538d4e423b8bb79aac274478bd32bec9123e7
14 changes: 1 addition & 13 deletions infra/feast-operator/api/v1alpha1/featurestore_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ limitations under the License.
package v1alpha1

import (
"fmt"

corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
Expand Down Expand Up @@ -87,21 +85,11 @@ type OfflineStoreFilePersistence struct {
Type string `json:"type,omitempty"`
}
Comment thread
dmartinol marked this conversation as resolved.

var validOfflineStoreFilePersistenceType = []string{
var ValidOfflineStoreFilePersistenceTypes = []string{
"dask",
"duckdb",
}

// A function to validate the file persistence types for offline stores
func IsValidOfflineStoreFilePersistenceType(value string) (bool, error) {
for _, v := range validOfflineStoreFilePersistenceType {
if v == value {
return true, nil
}
}
return false, fmt.Errorf("invalid file type %s for offline store", value)
}

// OnlineStore configures the deployed online store service
type OnlineStore struct {
ServiceConfigs `json:",inline"`
Expand Down
6 changes: 1 addition & 5 deletions infra/feast-operator/internal/controller/featurestore_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,7 @@ func (r *FeatureStoreReconciler) Reconcile(ctx context.Context, req ctrl.Request
currentStatus := cr.Status.DeepCopy()

// initial status defaults must occur before feast deployment
if err := services.ApplyDefaultsToStatus(cr); err != nil {
logger.Error(err, "Error updating the FeatureStore status")
result = ctrl.Result{Requeue: true, RequeueAfter: RequeueDelayError}
return result, err
}
services.ApplyDefaultsToStatus(cr)
result, recErr = r.deployFeast(ctx, cr)
if cr.DeletionTimestamp == nil && !reflect.DeepEqual(currentStatus, cr.Status) {
if err = r.Client.Status().Update(ctx, cr); err != nil {
Expand Down
30 changes: 5 additions & 25 deletions infra/feast-operator/internal/controller/services/repo_config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,9 @@ var _ = Describe("Repo Config", func() {
It("should successfully create the repo configs", func() {
By("Having the minimal created resource")
featureStore := minimalFeatureStore()
err := ApplyDefaultsToStatus(featureStore)
Expect(err).NotTo(HaveOccurred())
ApplyDefaultsToStatus(featureStore)
var repoConfig RepoConfig
repoConfig, err = getServiceRepoConfig(OfflineFeastType, featureStore)
repoConfig, err := getServiceRepoConfig(OfflineFeastType, featureStore)
Expect(err).NotTo(HaveOccurred())
Expect(repoConfig.OfflineStore).To(Equal(emptyOfflineStoreConfig()))
Expect(repoConfig.OnlineStore).To(Equal(emptyOnlineStoreConfig()))
Expand Down Expand Up @@ -69,8 +68,7 @@ var _ = Describe("Repo Config", func() {
},
},
}
err = ApplyDefaultsToStatus(featureStore)
Expect(err).NotTo(HaveOccurred())
ApplyDefaultsToStatus(featureStore)
repoConfig, err = getServiceRepoConfig(OfflineFeastType, featureStore)
Expect(err).NotTo(HaveOccurred())
Expect(repoConfig.OfflineStore).To(Equal(emptyOfflineStoreConfig()))
Expand Down Expand Up @@ -105,8 +103,7 @@ var _ = Describe("Repo Config", func() {
},
},
}
err = ApplyDefaultsToStatus(featureStore)
Expect(err).NotTo(HaveOccurred())
ApplyDefaultsToStatus(featureStore)
repoConfig, err = getServiceRepoConfig(OfflineFeastType, featureStore)
Expect(err).NotTo(HaveOccurred())
Expect(repoConfig.OfflineStore).To(Equal(emptyOfflineStoreConfig()))
Expand Down Expand Up @@ -152,8 +149,7 @@ var _ = Describe("Repo Config", func() {
},
},
}
err = ApplyDefaultsToStatus(featureStore)
Expect(err).NotTo(HaveOccurred())
ApplyDefaultsToStatus(featureStore)
repoConfig, err = getServiceRepoConfig(OfflineFeastType, featureStore)
Expect(err).NotTo(HaveOccurred())
expectedOfflineConfig := OfflineStoreConfig{
Expand Down Expand Up @@ -183,22 +179,6 @@ var _ = Describe("Repo Config", func() {
}
Expect(repoConfig.Registry).To(Equal(expectedRegistryConfig))
})

It("should fail the creation of repo configs", func() {
By("Having wrong offline persistence type")
featureStore := minimalFeatureStore()
featureStore.Spec.Services = &feastdevv1alpha1.FeatureStoreServices{
OfflineStore: &feastdevv1alpha1.OfflineStore{
Persistence: &feastdevv1alpha1.OfflineStorePersistence{
FilePersistence: &feastdevv1alpha1.OfflineStoreFilePersistence{
Type: "invalid",
},
},
},
}
err := ApplyDefaultsToStatus(featureStore)
Expect(err).To(HaveOccurred())
})
})
})

Expand Down
7 changes: 7 additions & 0 deletions infra/feast-operator/internal/controller/services/services.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,13 @@ func (feast *FeastServices) Deploy() error {
services := feast.FeatureStore.Status.Applied.Services
if services != nil {
if services.OfflineStore != nil {
if services.OfflineStore.Persistence != nil &&
services.OfflineStore.Persistence.FilePersistence != nil &&
len(services.OfflineStore.Persistence.FilePersistence.Type) > 0 {
if _, err := isValidOfflineStoreFilePersistenceType(services.OfflineStore.Persistence.FilePersistence.Type); err != nil {
return err
}
}
if err := feast.deployFeastServiceByType(OfflineFeastType); err != nil {
return err
}
Expand Down
76 changes: 41 additions & 35 deletions infra/feast-operator/internal/controller/services/util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package services

import (
"fmt"

"github.com/feast-dev/feast/infra/feast-operator/api/feastversion"
feastdevv1alpha1 "github.com/feast-dev/feast/infra/feast-operator/api/v1alpha1"
)
Expand All @@ -10,70 +12,74 @@ func IsLocalRegistry(featureStore *feastdevv1alpha1.FeatureStore) bool {
return appliedServices != nil && appliedServices.Registry != nil && appliedServices.Registry.Local != nil
}

func ApplyDefaultsToStatus(cr *feastdevv1alpha1.FeatureStore) error {
func ApplyDefaultsToStatus(cr *feastdevv1alpha1.FeatureStore) {
cr.Status.FeastVersion = feastversion.FeastVersion
applied := cr.Spec.DeepCopy()
if applied.Services == nil {
applied.Services = &feastdevv1alpha1.FeatureStoreServices{}
}
services := applied.Services

// default to registry service deployment
if applied.Services.Registry == nil {
applied.Services.Registry = &feastdevv1alpha1.Registry{}
if services.Registry == nil {
services.Registry = &feastdevv1alpha1.Registry{}
}
Comment thread
dmartinol marked this conversation as resolved.
// if remote registry not set, proceed w/ local registry defaults
if applied.Services.Registry.Remote == nil {
if services.Registry.Remote == nil {
// if local registry not set, apply an empty pointer struct
if applied.Services.Registry.Local == nil {
applied.Services.Registry.Local = &feastdevv1alpha1.LocalRegistryConfig{}
if services.Registry.Local == nil {
services.Registry.Local = &feastdevv1alpha1.LocalRegistryConfig{}
}
if applied.Services.Registry.Local.Persistence == nil {
applied.Services.Registry.Local.Persistence = &feastdevv1alpha1.RegistryPersistence{}
if services.Registry.Local.Persistence == nil {
services.Registry.Local.Persistence = &feastdevv1alpha1.RegistryPersistence{}
}
if applied.Services.Registry.Local.Persistence.FilePersistence == nil {
applied.Services.Registry.Local.Persistence.FilePersistence = &feastdevv1alpha1.RegistryFilePersistence{}
if services.Registry.Local.Persistence.FilePersistence == nil {
services.Registry.Local.Persistence.FilePersistence = &feastdevv1alpha1.RegistryFilePersistence{}
}
Comment thread
dmartinol marked this conversation as resolved.
if len(applied.Services.Registry.Local.Persistence.FilePersistence.Path) == 0 {
applied.Services.Registry.Local.Persistence.FilePersistence.Path = DefaultRegistryPath
if len(services.Registry.Local.Persistence.FilePersistence.Path) == 0 {
services.Registry.Local.Persistence.FilePersistence.Path = DefaultRegistryPath
}
setServiceDefaultConfigs(&applied.Services.Registry.Local.ServiceConfigs.DefaultConfigs)
setServiceDefaultConfigs(&services.Registry.Local.ServiceConfigs.DefaultConfigs)
}
if applied.Services.OfflineStore != nil {
setServiceDefaultConfigs(&applied.Services.OfflineStore.ServiceConfigs.DefaultConfigs)
if applied.Services.OfflineStore.Persistence == nil {
applied.Services.OfflineStore.Persistence = &feastdevv1alpha1.OfflineStorePersistence{}
if services.OfflineStore != nil {
setServiceDefaultConfigs(&services.OfflineStore.ServiceConfigs.DefaultConfigs)
if services.OfflineStore.Persistence == nil {
services.OfflineStore.Persistence = &feastdevv1alpha1.OfflineStorePersistence{}
}
if applied.Services.OfflineStore.Persistence.FilePersistence == nil {
applied.Services.OfflineStore.Persistence.FilePersistence = &feastdevv1alpha1.OfflineStoreFilePersistence{}
if services.OfflineStore.Persistence.FilePersistence == nil {
services.OfflineStore.Persistence.FilePersistence = &feastdevv1alpha1.OfflineStoreFilePersistence{}
}
if len(applied.Services.OfflineStore.Persistence.FilePersistence.Type) == 0 {
applied.Services.OfflineStore.Persistence.FilePersistence.Type = string(OfflineDaskConfigType)
} else {
_, err := feastdevv1alpha1.IsValidOfflineStoreFilePersistenceType(applied.Services.OfflineStore.Persistence.FilePersistence.Type)
if err != nil {
return err
}
if len(services.OfflineStore.Persistence.FilePersistence.Type) == 0 {
services.OfflineStore.Persistence.FilePersistence.Type = string(OfflineDaskConfigType)
}
}
Comment thread
dmartinol marked this conversation as resolved.
if applied.Services.OnlineStore != nil {
setServiceDefaultConfigs(&applied.Services.OnlineStore.ServiceConfigs.DefaultConfigs)
if applied.Services.OnlineStore.Persistence == nil {
applied.Services.OnlineStore.Persistence = &feastdevv1alpha1.OnlineStorePersistence{}
if services.OnlineStore != nil {
setServiceDefaultConfigs(&services.OnlineStore.ServiceConfigs.DefaultConfigs)
if services.OnlineStore.Persistence == nil {
services.OnlineStore.Persistence = &feastdevv1alpha1.OnlineStorePersistence{}
}
if applied.Services.OnlineStore.Persistence.FilePersistence == nil {
applied.Services.OnlineStore.Persistence.FilePersistence = &feastdevv1alpha1.OnlineStoreFilePersistence{}
if services.OnlineStore.Persistence.FilePersistence == nil {
services.OnlineStore.Persistence.FilePersistence = &feastdevv1alpha1.OnlineStoreFilePersistence{}
}
if len(applied.Services.OnlineStore.Persistence.FilePersistence.Path) == 0 {
applied.Services.OnlineStore.Persistence.FilePersistence.Path = DefaultOnlinePath
if len(services.OnlineStore.Persistence.FilePersistence.Path) == 0 {
services.OnlineStore.Persistence.FilePersistence.Path = DefaultOnlinePath
}
}
Copy link
Copy Markdown
Contributor

@tchughesiv tchughesiv Nov 6, 2024

Choose a reason for hiding this comment

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

same

Copy link
Copy Markdown
Contributor

@tchughesiv tchughesiv Nov 6, 2024

Choose a reason for hiding this comment

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

would be good to have unit tests ensuring that proper defaults are being set in status when varying pointers around service persistence are set in the spec.

Copy link
Copy Markdown
Contributor Author

@dmartinol dmartinol Nov 6, 2024

Choose a reason for hiding this comment

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

would be good to have unit tests ensuring that proper defaults are being set in status when varying pointers around service persistence are set in the spec.

This was the idea of repo_config_test.go, which verifies the repo config created after applying the defaults.

Copy link
Copy Markdown
Contributor

@tchughesiv tchughesiv Nov 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

that's a great addition, and necessary, but its different from ensuring the status defaults are properly being reconciled in the CR.

Copy link
Copy Markdown
Contributor Author

@dmartinol dmartinol Nov 7, 2024

Choose a reason for hiding this comment

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

I see what you mean, I'll add it in the next PR for PVC so there will be more cases to cover

// overwrite status.applied with every reconcile
applied.DeepCopyInto(&cr.Status.Applied)
return nil
}

func setServiceDefaultConfigs(defaultConfigs *feastdevv1alpha1.DefaultConfigs) {
if defaultConfigs.Image == nil {
defaultConfigs.Image = &DefaultImage
}
}

func isValidOfflineStoreFilePersistenceType(value string) (bool, error) {
for _, v := range feastdevv1alpha1.ValidOfflineStoreFilePersistenceTypes {
if v == value {
return true, nil
}
}
return false, fmt.Errorf("invalid file type %s for offline store", value)
}
Comment thread
dmartinol marked this conversation as resolved.
Outdated