Package v1alpha1 contains API Schema definitions for the v1alpha1 API group
AuthzConfig defines the authorization settings for the deployed Feast services.
Appears in:
| Field | Description |
|---|---|
kubernetes KubernetesAuthz |
|
oidc OidcAuthz |
ContainerConfigs k8s container settings for the server
Appears in:
| Field | Description |
|---|---|
image string |
|
env EnvVar |
|
envFrom EnvFromSource |
|
imagePullPolicy PullPolicy |
|
resources ResourceRequirements |
DefaultCtrConfigs k8s container settings that are applied by default
Appears in:
| Field | Description |
|---|---|
image string |
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 defines which existing FeatureStore's registry should be used
Appears in:
| Field | Description |
|---|---|
name string |
Name of the FeatureStore |
namespace string |
Namespace of the FeatureStore |
FeatureStoreServices defines the desired feast services. An ephemeral onlineStore feature server is deployed by default.
Appears in:
| Field | Description |
|---|---|
offlineStore OfflineStore |
|
onlineStore OnlineStore |
|
registry Registry |
|
ui ServerConfigs |
Creates a UI server container |
deploymentStrategy DeploymentStrategy |
|
disableInitContainers boolean |
Disable the 'feast repo initialization' initContainer |
volumes Volume array |
Volumes specifies the volumes to mount in the FeatureStore deployment. A corresponding VolumeMount should be added to whichever feast service(s) require access to said volume(s). |
FeatureStoreSpec defines the desired state of FeatureStore
Appears in:
| 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 defines the observed state of FeatureStore
Appears in:
| 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 provides a way to define the authorization settings using Kubernetes RBAC resources. https://kubernetes.io/docs/reference/access-authn-authz/rbac/
Appears in:
| 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 configures the registry service
Appears in:
| Field | Description |
|---|---|
server ServerConfigs |
Creates a registry server container |
persistence RegistryPersistence |
OfflineStore configures the offline store service
Appears in:
| Field | Description |
|---|---|
server ServerConfigs |
Creates a remote offline server container |
persistence OfflineStorePersistence |
OfflineStoreDBStorePersistence configures the DB store persistence for the offline store service
Appears in:
| Field | Description |
|---|---|
type string |
Type of the persistence type you want to use. |
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 configures the file-based persistence for the offline store service
Appears in:
| Field | Description |
|---|---|
type string |
|
pvc PvcConfig |
OfflineStorePersistence configures the persistence settings for the offline store service
Appears in:
| Field | Description |
|---|---|
file OfflineStoreFilePersistence |
|
store OfflineStoreDBStorePersistence |
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:
| Field | Description |
|---|---|
secretRef LocalObjectReference |
OnlineStore configures the online store service
Appears in:
| Field | Description |
|---|---|
server ServerConfigs |
Creates a feature server container |
persistence OnlineStorePersistence |
OnlineStoreDBStorePersistence configures the DB store persistence for the online store service
Appears in:
| Field | Description |
|---|---|
type string |
Type of the persistence type you want to use. |
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 configures the file-based persistence for the online store service
Appears in:
| Field | Description |
|---|---|
path string |
|
pvc PvcConfig |
OnlineStorePersistence configures the persistence settings for the online store service
Appears in:
| Field | Description |
|---|---|
file OnlineStoreFilePersistence |
|
store OnlineStoreDBStorePersistence |
OptionalCtrConfigs k8s container settings that are optional
Appears in:
| Field | Description |
|---|---|
env EnvVar |
|
envFrom EnvFromSource |
|
imagePullPolicy PullPolicy |
|
resources ResourceRequirements |
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:
| Field | Description |
|---|---|
ref LocalObjectReference |
Reference to an existing field |
create PvcCreate |
Settings for creating a new PVC |
mountPath string |
MountPath within the container at which the volume should be mounted. |
| Must start by "/" and cannot contain ':'. |
PvcCreate defines the immutable settings to create a new PVC mounted at the given path. The PVC name is the same as the associated deployment & feast service name.
Appears in:
| Field | Description |
|---|---|
accessModes PersistentVolumeAccessMode array |
AccessModes k8s persistent volume access modes. Defaults to ["ReadWriteOnce"]. |
storageClassName string |
StorageClassName is the name of an existing StorageClass to which this persistent volume belongs. Empty value |
| means that this volume does not belong to any StorageClass and the cluster default will be used. | |
resources VolumeResourceRequirements |
Resources describes the storage resource requirements for a volume. |
| Default requested storage size depends on the associated service: |
- 10Gi for offline store
- 5Gi for online store
- 5Gi for registry |
Registry configures the registry service. One selection is required. Local is the default setting.
Appears in:
| Field | Description |
|---|---|
local LocalRegistryConfig |
|
remote RemoteRegistryConfig |
RegistryDBStorePersistence configures the DB store persistence for the registry service
Appears in:
| Field | Description |
|---|---|
type string |
Type of the persistence type you want to use. |
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 |
RegistryFilePersistence configures the file-based persistence for the registry service
Appears in:
| Field | Description |
|---|---|
path string |
|
pvc PvcConfig |
|
s3_additional_kwargs map[string]string |
RegistryPersistence configures the persistence settings for the registry service
Appears in:
| Field | Description |
|---|---|
file RegistryFilePersistence |
|
store RegistryDBStorePersistence |
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:
| 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 defines the secret key names for the TLS key and cert.
Appears in:
| Field | Description |
|---|---|
tlsCrt string |
defaults to "tls.crt" |
tlsKey string |
defaults to "tls.key" |
ServerConfigs creates a server for the feast service, with specified container configurations.
Appears in:
| Field | Description |
|---|---|
image string |
|
env EnvVar |
|
envFrom EnvFromSource |
|
imagePullPolicy PullPolicy |
|
resources ResourceRequirements |
|
tls TlsConfigs |
|
logLevel string |
LogLevel sets the logging level for the server |
| Allowed values: "debug", "info", "warning", "error", "critical". | |
volumeMounts VolumeMount array |
VolumeMounts defines the list of volumes that should be mounted into the feast container. |
| This allows attaching persistent storage, config files, secrets, or other resources | |
| required by the Feast components. Ensure that each volume mount has a corresponding | |
| volume definition in the Volumes field. |
ServiceHostnames defines the service hostnames in the format of :, e.g. example.svc.cluster.local:80
Appears in:
| Field | Description |
|---|---|
offlineStore string |
|
onlineStore string |
|
registry string |
|
ui string |
TlsConfigs configures server TLS for a feast service. in an openshift cluster, this is configured by default using service serving certificates.
Appears in:
| 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 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:
| 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. |