API Reference

Packages

• feast.dev/v1alpha1

feast.dev/v1alpha1

Package v1alpha1 contains API Schema definitions for the v1alpha1 API group

Resource Types

• FeatureStore

AuthzConfig

AuthzConfig defines the authorization settings for the deployed Feast services.

Appears in:

• FeatureStoreSpec

Field	Description
kubernetes KubernetesAuthz
oidc OidcAuthz

DefaultConfigs

DefaultConfigs k8s container settings that are applied by default

Appears in:

• LocalRegistryConfig
• OfflineStore
• OnlineStore
• ServiceConfigs

Field	Description
image string

FeatureStore

FeatureStore is the Schema for the featurestores API

Field	Description
apiVersion string	feast.dev/v1alpha1
kind string	FeatureStore
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec FeatureStoreSpec
status FeatureStoreStatus

FeatureStoreRef

FeatureStoreRef defines which existing FeatureStore's registry should be used

Appears in:

• RemoteRegistryConfig

Field	Description
name string	Name of the FeatureStore
namespace string	Namespace of the FeatureStore

FeatureStoreServices

FeatureStoreServices defines the desired feast services. An ephemeral registry is deployed by default.

Appears in:

• FeatureStoreSpec

Field	Description
offlineStore OfflineStore
onlineStore OnlineStore
registry Registry
deploymentStrategy DeploymentStrategy
disableInitContainers boolean	Disable the 'feast repo initialization' initContainer

FeatureStoreSpec

FeatureStoreSpec defines the desired state of FeatureStore

Appears in:

• FeatureStore
• FeatureStoreStatus

Field	Description
feastProject string	FeastProject is the Feast project id. This can be any alphanumeric string with underscores, but it cannot start with an underscore. Required.
services FeatureStoreServices
authz AuthzConfig

FeatureStoreStatus

FeatureStoreStatus defines the observed state of FeatureStore

Appears in:

• FeatureStore

Field	Description
applied FeatureStoreSpec	Shows the currently applied feast configuration, including any pertinent defaults
clientConfigMap string	ConfigMap in this namespace containing a client feature_store.yaml for this feast deployment
conditions Condition array
feastVersion string
phase string
serviceHostnames ServiceHostnames

KubernetesAuthz

KubernetesAuthz provides a way to define the authorization settings using Kubernetes RBAC resources. https://kubernetes.io/docs/reference/access-authn-authz/rbac/

Appears in:

• AuthzConfig

Field	Description
roles string array	The Kubernetes RBAC roles to be deployed in the same namespace of the FeatureStore.
Roles are managed by the operator and created with an empty list of rules.
See the Feast permission model at https://docs.feast.dev/getting-started/concepts/permission
The feature store admin is not obligated to manage roles using the Feast operator, roles can be managed independently.
This configuration option is only providing a way to automate this procedure.
Important note: the operator cannot ensure that these roles will match the ones used in the configured Feast permissions.

LocalRegistryConfig

LocalRegistryConfig configures the deployed registry service

Appears in:

• Registry

Field	Description
image string
env EnvVar
envFrom EnvFromSource
imagePullPolicy PullPolicy
resources ResourceRequirements
persistence RegistryPersistence
tls TlsConfigs
logLevel string	LogLevel sets the logging level for the registry service
Allowed values: "debug", "info", "warning", "error", "critical".

OfflineStore

OfflineStore configures the deployed offline store service

Appears in:

• FeatureStoreServices

Field	Description
image string
env EnvVar
envFrom EnvFromSource
imagePullPolicy PullPolicy
resources ResourceRequirements
persistence OfflineStorePersistence
tls TlsConfigs
logLevel string	LogLevel sets the logging level for the offline store service
Allowed values: "debug", "info", "warning", "error", "critical".

OfflineStoreDBStorePersistence

OfflineStoreDBStorePersistence configures the DB store persistence for the offline store service

Appears in:

• OfflineStorePersistence

Field	Description
type string
secretRef LocalObjectReference	Data store parameters should be placed as-is from the "feature_store.yaml" under the secret key. "registry_type" & "type" fields should be removed.
secretKeyName string	By default, the selected store "type" is used as the SecretKeyName

OfflineStoreFilePersistence

OfflineStoreFilePersistence configures the file-based persistence for the offline store service

Appears in:

• OfflineStorePersistence

Field	Description
type string
pvc PvcConfig

OfflineStorePersistence

OfflineStorePersistence configures the persistence settings for the offline store service

Appears in:

• OfflineStore

Field	Description
file OfflineStoreFilePersistence
store OfflineStoreDBStorePersistence

OidcAuthz

OidcAuthz defines the authorization settings for deployments using an Open ID Connect identity provider. https://auth0.com/docs/authenticate/protocols/openid-connect-protocol

Appears in:

• AuthzConfig

Field	Description
secretRef LocalObjectReference

OnlineStore

OnlineStore configures the deployed online store service

Appears in:

• FeatureStoreServices

Field	Description
image string
env EnvVar
envFrom EnvFromSource
imagePullPolicy PullPolicy
resources ResourceRequirements
persistence OnlineStorePersistence
tls TlsConfigs
logLevel string	LogLevel sets the logging level for the online store service
Allowed values: "debug", "info", "warning", "error", "critical".

OnlineStoreDBStorePersistence

OnlineStoreDBStorePersistence configures the DB store persistence for the offline store service

Appears in:

• OnlineStorePersistence

Field	Description
type string
secretRef LocalObjectReference	Data store parameters should be placed as-is from the "feature_store.yaml" under the secret key. "registry_type" & "type" fields should be removed.
secretKeyName string	By default, the selected store "type" is used as the SecretKeyName

OnlineStoreFilePersistence

OnlineStoreFilePersistence configures the file-based persistence for the offline store service

Appears in:

• OnlineStorePersistence

Field	Description
path string
pvc PvcConfig

OnlineStorePersistence

OnlineStorePersistence configures the persistence settings for the online store service

Appears in:

• OnlineStore

Field	Description
file OnlineStoreFilePersistence
store OnlineStoreDBStorePersistence

OptionalConfigs

OptionalConfigs k8s container settings that are optional

Appears in:

• LocalRegistryConfig
• OfflineStore
• OnlineStore
• ServiceConfigs

Field	Description
env EnvVar
envFrom EnvFromSource
imagePullPolicy PullPolicy
resources ResourceRequirements

PvcConfig

Underlying type: [struct{Ref *k8s.io/api/core/v1.LocalObjectReference "json:\"ref,omitempty\""; Create *PvcCreate "json:\"create,omitempty\""; MountPath string "json:\"mountPath\""}](#struct{ref-*k8sioapicorev1localobjectreference-"json:\"ref,omitempty\"";-create-*pvccreate-"json:\"create,omitempty\"";-mountpath-string-"json:\"mountpath\""})

PvcConfig defines the settings for a persistent file store based on PVCs. We can refer to an existing PVC using the Ref field, or create a new one using the Create field.

Appears in:

• OfflineStoreFilePersistence
• OnlineStoreFilePersistence

Registry

Registry configures the registry service. One selection is required. Local is the default setting.

Appears in:

• FeatureStoreServices

Field	Description
local LocalRegistryConfig
remote RemoteRegistryConfig

RegistryDBStorePersistence

Underlying type: [struct{Type string "json:\"type\""; SecretRef k8s.io/api/core/v1.LocalObjectReference "json:\"secretRef\""; SecretKeyName string "json:\"secretKeyName,omitempty\""}](#struct{type-string-"json:\"type\"";-secretref-k8sioapicorev1localobjectreference-"json:\"secretref\"";-secretkeyname-string-"json:\"secretkeyname,omitempty\""})

RegistryDBStorePersistence configures the DB store persistence for the registry service

Appears in:

• RegistryPersistence

RegistryFilePersistence

Underlying type: [struct{Path string "json:\"path,omitempty\""; PvcConfig *PvcConfig "json:\"pvc,omitempty\""; S3AdditionalKwargs *map[string]string "json:\"s3_additional_kwargs,omitempty\""}](#struct{path-string-"json:\"path,omitempty\"";-pvcconfig-*pvcconfig-"json:\"pvc,omitempty\"";-s3additionalkwargs-*map[string]string-"json:\"s3_additional_kwargs,omitempty\""})

RegistryFilePersistence configures the file-based persistence for the registry service

Appears in:

• RegistryPersistence

RegistryPersistence

RegistryPersistence configures the persistence settings for the registry service

Appears in:

• LocalRegistryConfig

Field	Description
file RegistryFilePersistence
store RegistryDBStorePersistence

RemoteRegistryConfig

RemoteRegistryConfig points to a remote feast registry server. When set, the operator will not deploy a registry for this FeatureStore CR. Instead, this FeatureStore CR's online/offline services will use a remote registry. One selection is required.

Appears in:

• Registry

Field	Description
hostname string	Host address of the remote registry service - :, e.g. registry.<namespace>.svc.cluster.local:80
feastRef FeatureStoreRef	Reference to an existing FeatureStore CR in the same k8s cluster.
tls TlsRemoteRegistryConfigs

SecretKeyNames

SecretKeyNames defines the secret key names for the TLS key and cert.

Appears in:

• TlsConfigs

Field	Description
tlsCrt string	defaults to "tls.crt"
tlsKey string	defaults to "tls.key"

ServiceConfigs

ServiceConfigs k8s container settings

Appears in:

• LocalRegistryConfig
• OfflineStore
• OnlineStore

Field	Description
image string
env EnvVar
envFrom EnvFromSource
imagePullPolicy PullPolicy
resources ResourceRequirements

ServiceHostnames

ServiceHostnames defines the service hostnames in the format of :, e.g. example.svc.cluster.local:80

Appears in:

• FeatureStoreStatus

Field	Description
offlineStore string
onlineStore string
registry string

TlsConfigs

TlsConfigs configures server TLS for a feast service. in an openshift cluster, this is configured by default using service serving certificates.

Appears in:

• LocalRegistryConfig
• OfflineStore
• OnlineStore

Field	Description
secretRef LocalObjectReference	references the local k8s secret where the TLS key and cert reside
secretKeyNames SecretKeyNames
disable boolean	will disable TLS for the feast service. useful in an openshift cluster, for example, where TLS is configured by default

TlsRemoteRegistryConfigs

TlsRemoteRegistryConfigs configures client TLS for a remote feast registry. in an openshift cluster, this is configured by default when the remote feast registry is using service serving certificates.

Appears in:

• RemoteRegistryConfig

Field	Description
configMapRef LocalObjectReference	references the local k8s configmap where the TLS cert resides
certName string	defines the configmap key name for the client TLS cert.