Skip to content

Commit 568054e

Browse files
jfw-ppijfw-ppi
committed
feat: add cache configs for file-based registry in Feast Operator (#5708)
Signed-off-by: Jacob Weinhold <29459386+jfw-ppi@users.noreply.github.com>
1 parent 7a99166 commit 568054e

10 files changed

Lines changed: 191 additions & 3 deletions

File tree

‎infra/feast-operator/api/v1alpha1/featurestore_types.go‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,17 @@ type RegistryFilePersistence struct {
421421
Path string `json:"path,omitempty"`
422422
PvcConfig *PvcConfig `json:"pvc,omitempty"`
423423
S3AdditionalKwargs *map[string]string `json:"s3_additional_kwargs,omitempty"`
424+
425+
// CacheTTLSeconds defines the TTL (in seconds) for the registry cache.
426+
// +kubebuilder:validation:Minimum=0
427+
// +optional
428+
CacheTTLSeconds *int32 `json:"cache_ttl_seconds,omitempty"`
429+
430+
// CacheMode defines the registry cache update strategy.
431+
// Allowed values are "sync" and "thread".
432+
// +kubebuilder:validation:Enum=none;sync;thread
433+
// +optional
434+
CacheMode *string `json:"cache_mode,omitempty"`
424435
}
425436

426437
// RegistryDBStorePersistence configures the DB store persistence for the registry service

‎infra/feast-operator/api/v1alpha1/zz_generated.deepcopy.go‎

Lines changed: 10 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎infra/feast-operator/config/crd/bases/feast.dev_featurestores.yaml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1649,6 +1649,21 @@ spec:
16491649
description: RegistryFilePersistence configures the
16501650
file-based persistence for the registry service
16511651
properties:
1652+
cache_mode:
1653+
description: |-
1654+
CacheMode defines the registry cache update strategy.
1655+
Allowed values are "sync" and "thread".
1656+
enum:
1657+
- none
1658+
- sync
1659+
- thread
1660+
type: string
1661+
cache_ttl_seconds:
1662+
description: CacheTTLSeconds defines the TTL (in
1663+
seconds) for the registry cache.
1664+
format: int32
1665+
minimum: 0
1666+
type: integer
16521667
path:
16531668
type: string
16541669
pvc:
@@ -5661,6 +5676,21 @@ spec:
56615676
the file-based persistence for the registry
56625677
service
56635678
properties:
5679+
cache_mode:
5680+
description: |-
5681+
CacheMode defines the registry cache update strategy.
5682+
Allowed values are "sync" and "thread".
5683+
enum:
5684+
- none
5685+
- sync
5686+
- thread
5687+
type: string
5688+
cache_ttl_seconds:
5689+
description: CacheTTLSeconds defines the TTL
5690+
(in seconds) for the registry cache.
5691+
format: int32
5692+
minimum: 0
5693+
type: integer
56645694
path:
56655695
type: string
56665696
pvc:

‎infra/feast-operator/config/samples/v1alpha1_featurestore_objectstore_persistence.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ spec:
1010
persistence:
1111
file:
1212
path: s3://bucket/registry.db
13+
cache_ttl_seconds: 60
14+
cache_mode: sync
1315
s3_additional_kwargs:
1416
ServerSideEncryption: AES256
1517
ACL: bucket-owner-full-control

‎infra/feast-operator/dist/install.yaml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1657,6 +1657,21 @@ spec:
16571657
description: RegistryFilePersistence configures the
16581658
file-based persistence for the registry service
16591659
properties:
1660+
cache_mode:
1661+
description: |-
1662+
CacheMode defines the registry cache update strategy.
1663+
Allowed values are "sync" and "thread".
1664+
enum:
1665+
- none
1666+
- sync
1667+
- thread
1668+
type: string
1669+
cache_ttl_seconds:
1670+
description: CacheTTLSeconds defines the TTL (in
1671+
seconds) for the registry cache.
1672+
format: int32
1673+
minimum: 0
1674+
type: integer
16601675
path:
16611676
type: string
16621677
pvc:
@@ -5669,6 +5684,21 @@ spec:
56695684
the file-based persistence for the registry
56705685
service
56715686
properties:
5687+
cache_mode:
5688+
description: |-
5689+
CacheMode defines the registry cache update strategy.
5690+
Allowed values are "sync" and "thread".
5691+
enum:
5692+
- none
5693+
- sync
5694+
- thread
5695+
type: string
5696+
cache_ttl_seconds:
5697+
description: CacheTTLSeconds defines the TTL
5698+
(in seconds) for the registry cache.
5699+
format: int32
5700+
minimum: 0
5701+
type: integer
56725702
path:
56735703
type: string
56745704
pvc:

‎infra/feast-operator/docs/api/markdown/ref.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -662,6 +662,9 @@ _Appears in:_
662662
| `path` _string_ | |
663663
| `pvc` _[PvcConfig](#pvcconfig)_ | |
664664
| `s3_additional_kwargs` _map[string]string_ | |
665+
| `cache_ttl_seconds` _integer_ | CacheTTLSeconds defines the TTL (in seconds) for the registry cache. |
666+
| `cache_mode` _string_ | CacheMode defines the registry cache update strategy.
667+
Allowed values are "sync" and "thread". |
665668

666669

667670
#### RegistryPersistence

‎infra/feast-operator/internal/controller/featurestore_controller_db_store_test.go‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -574,6 +574,11 @@ var _ = Describe("FeatureStore Controller - db storage services", func() {
574574
dbParametersMap := unmarshallYamlString(sqlTypeYamlString)
575575
copyMap := services.CopyMap(dbParametersMap)
576576
delete(dbParametersMap, "path")
577+
// Expect cache_ttl_seconds to be mapped into Registry.CacheTTLSeconds
578+
ttlVal, ok := copyMap["cache_ttl_seconds"].(int)
579+
Expect(ok).To(BeTrue())
580+
ttl := int32(ttlVal)
581+
delete(dbParametersMap, "cache_ttl_seconds")
577582
testConfig := &services.RepoConfig{
578583
Project: feastProject,
579584
Provider: services.LocalProviderType,
@@ -583,9 +588,10 @@ var _ = Describe("FeatureStore Controller - db storage services", func() {
583588
DBParameters: unmarshallYamlString(snowflakeYamlString),
584589
},
585590
Registry: services.RegistryConfig{
586-
Path: copyMap["path"].(string),
587-
RegistryType: services.RegistryDBPersistenceSQLConfigType,
588-
DBParameters: dbParametersMap,
591+
Path: copyMap["path"].(string),
592+
RegistryType: services.RegistryDBPersistenceSQLConfigType,
593+
CacheTTLSeconds: &ttl,
594+
DBParameters: dbParametersMap,
589595
},
590596
OnlineStore: services.OnlineStoreConfig{
591597
Type: onlineType,

‎infra/feast-operator/internal/controller/featurestore_controller_objectstore_test.go‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -367,5 +367,67 @@ var _ = Describe("FeatureStore Controller-Ephemeral services", func() {
367367
testConfig.Registry.S3AdditionalKwargs = nil
368368
Expect(repoConfig).To(Equal(&testConfig))
369369
})
370+
371+
It("should propagate registry file cache settings into repo config", func() {
372+
By("Reconciling the created resource with registry cache settings")
373+
controllerReconciler := &FeatureStoreReconciler{
374+
Client: k8sClient,
375+
Scheme: k8sClient.Scheme(),
376+
}
377+
378+
// update the FeatureStore to set cache settings on registry file persistence
379+
resource := &feastdevv1alpha1.FeatureStore{}
380+
err := k8sClient.Get(ctx, typeNamespacedName, resource)
381+
Expect(err).NotTo(HaveOccurred())
382+
383+
ttl := int32(300)
384+
mode := "thread"
385+
resource.Spec.Services.Registry.Local.Persistence.FilePersistence.CacheTTLSeconds = &ttl
386+
resource.Spec.Services.Registry.Local.Persistence.FilePersistence.CacheMode = &mode
387+
err = k8sClient.Update(ctx, resource)
388+
Expect(err).NotTo(HaveOccurred())
389+
390+
_, err = controllerReconciler.Reconcile(ctx, reconcile.Request{
391+
NamespacedName: typeNamespacedName,
392+
})
393+
Expect(err).NotTo(HaveOccurred())
394+
395+
// fetch updated resource and deployment
396+
resource = &feastdevv1alpha1.FeatureStore{}
397+
err = k8sClient.Get(ctx, typeNamespacedName, resource)
398+
Expect(err).NotTo(HaveOccurred())
399+
400+
feast := services.FeastServices{
401+
Handler: handler.FeastHandler{
402+
Client: controllerReconciler.Client,
403+
Context: ctx,
404+
Scheme: controllerReconciler.Scheme,
405+
FeatureStore: resource,
406+
},
407+
}
408+
409+
deploy := &appsv1.Deployment{}
410+
objMeta := feast.GetObjectMeta()
411+
err = k8sClient.Get(ctx, types.NamespacedName{
412+
Name: objMeta.Name,
413+
Namespace: objMeta.Namespace,
414+
}, deploy)
415+
Expect(err).NotTo(HaveOccurred())
416+
417+
env := getFeatureStoreYamlEnvVar(services.GetRegistryContainer(*deploy).Env)
418+
Expect(env).NotTo(BeNil())
419+
420+
// decode feature_store.yaml and verify registry cache settings
421+
envByte, err := base64.StdEncoding.DecodeString(env.Value)
422+
Expect(err).NotTo(HaveOccurred())
423+
repoConfig := &services.RepoConfig{}
424+
err = yaml.Unmarshal(envByte, repoConfig)
425+
Expect(err).NotTo(HaveOccurred())
426+
427+
Expect(repoConfig.Registry.CacheTTLSeconds).NotTo(BeNil())
428+
Expect(*repoConfig.Registry.CacheTTLSeconds).To(Equal(ttl))
429+
Expect(repoConfig.Registry.CacheMode).NotTo(BeNil())
430+
Expect(*repoConfig.Registry.CacheMode).To(Equal(mode))
431+
})
370432
})
371433
})

‎infra/feast-operator/internal/controller/services/repo_config.go‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,13 @@ func setRepoConfigRegistry(services *feastdevv1alpha1.FeatureStoreServices, secr
127127
repoConfig.Registry.RegistryType = RegistryFileConfigType
128128
repoConfig.Registry.Path = getActualPath(filePersistence.Path, filePersistence.PvcConfig)
129129
repoConfig.Registry.S3AdditionalKwargs = filePersistence.S3AdditionalKwargs
130+
if filePersistence.CacheTTLSeconds != nil {
131+
repoConfig.Registry.CacheTTLSeconds = filePersistence.CacheTTLSeconds
132+
}
133+
if filePersistence.CacheMode != nil {
134+
repoConfig.Registry.CacheMode = filePersistence.CacheMode
135+
}
136+
130137
} else if dbPersistence != nil && len(dbPersistence.Type) > 0 {
131138
repoConfig.Registry.Path = ""
132139
repoConfig.Registry.RegistryType = RegistryConfigType(dbPersistence.Type)
@@ -139,6 +146,31 @@ func setRepoConfigRegistry(services *feastdevv1alpha1.FeatureStoreServices, secr
139146
return err
140147
}
141148

149+
// Extract typed cache settings from DB parameters to avoid inline map conflicts
150+
if ttlVal, ok := parametersMap["cache_ttl_seconds"]; ok {
151+
switch v := ttlVal.(type) {
152+
case int:
153+
ttl := int32(v)
154+
repoConfig.Registry.CacheTTLSeconds = &ttl
155+
case int32:
156+
ttl := v
157+
repoConfig.Registry.CacheTTLSeconds = &ttl
158+
case int64:
159+
ttl := int32(v)
160+
repoConfig.Registry.CacheTTLSeconds = &ttl
161+
case float64:
162+
ttl := int32(v)
163+
repoConfig.Registry.CacheTTLSeconds = &ttl
164+
}
165+
delete(parametersMap, "cache_ttl_seconds")
166+
}
167+
if modeVal, ok := parametersMap["cache_mode"]; ok {
168+
if modeStr, ok := modeVal.(string); ok {
169+
repoConfig.Registry.CacheMode = &modeStr
170+
}
171+
delete(parametersMap, "cache_mode")
172+
}
173+
142174
err = mergeStructWithDBParametersMap(&parametersMap, &repoConfig.Registry)
143175
if err != nil {
144176
return err

‎infra/feast-operator/internal/controller/services/services_types.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,8 @@ type RegistryConfig struct {
280280
RegistryType RegistryConfigType `yaml:"registry_type,omitempty"`
281281
Cert string `yaml:"cert,omitempty"`
282282
S3AdditionalKwargs *map[string]string `yaml:"s3_additional_kwargs,omitempty"`
283+
CacheTTLSeconds *int32 `yaml:"cache_ttl_seconds,omitempty"`
284+
CacheMode *string `yaml:"cache_mode,omitempty"`
283285
DBParameters map[string]interface{} `yaml:",inline,omitempty"`
284286
}
285287

0 commit comments

Comments
 (0)