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 |
CronJobContainerConfigs k8s container settings for the CronJob
Appears in:
| Field | Description |
|---|---|
image string |
|
env EnvVar |
|
envFrom EnvFromSource |
|
imagePullPolicy PullPolicy |
|
resources ResourceRequirements |
|
commands string array |
Array of commands to be executed (in order) against a Feature Store deployment. |
| Defaults to "feast apply" & "feast materialize-incremental $(date -u +'%Y-%m-%dT%H:%M:%S')" |
DefaultCtrConfigs k8s container settings that are applied by default
Appears in:
| Field | Description |
|---|---|
image string |
FeastCronJob defines a CronJob to execute against a Feature Store deployment.
Appears in:
| Field | Description |
|---|---|
jobSpec JobSpec |
Specification of the desired behavior of a job. |
containerConfigs CronJobContainerConfigs |
|
schedule string |
The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. |
timeZone string |
The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
| If not specified, this will default to the time zone of the kube-controller-manager process. | |
| The set of valid time zone names and the time zone offset is loaded from the system-wide time zone | |
| database by the API server during CronJob validation and the controller manager during execution. | |
| If no system-wide time zone database can be found a bundled version of the database is used instead. | |
| If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host | |
| configuration, the controller will stop creating new new Jobs and will create a system event with the | |
| reason UnknownTimeZone. | |
| More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones | |
startingDeadlineSeconds integer |
Optional deadline in seconds for starting the job if it misses scheduled |
| time for any reason. Missed jobs executions will be counted as failed ones. | |
concurrencyPolicy ConcurrencyPolicy |
Specifies how to treat concurrent executions of a Job. |
| Valid values are: |
- "Allow" (default): allows CronJobs to run concurrently;
- "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- "Replace": cancels currently running job and replaces it with a new one |
|
suspendboolean | This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. | |successfulJobsHistoryLimitinteger | The number of successful finished jobs to retain. Value must be non-negative integer. | |failedJobsHistoryLimitinteger | The number of failed finished jobs to retain. Value must be non-negative integer. |
FeastInitOptions defines how to run a feast init.
Appears in:
| Field | Description |
|---|---|
minimal boolean |
|
template string |
Template for the created project |
FeastProjectDir defines how to create the feast project directory.
Appears in:
| Field | Description |
|---|---|
git GitCloneOptions |
|
init FeastInitOptions |
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. |
feastProjectDir FeastProjectDir |
|
services FeatureStoreServices |
|
authz AuthzConfig |
|
cronJob FeastCronJob |
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 |
cronJob string |
CronJob in this namespace for this feast deployment |
conditions Condition array |
|
feastVersion string |
|
phase string |
|
serviceHostnames ServiceHostnames |
GitCloneOptions describes how a clone should be performed.
Appears in:
| Field | Description |
|---|---|
url string |
The repository URL to clone from. |
ref string |
Reference to a branch / tag / commit |
configs object (keys:string, values:string) |
Configs passed to git via -c |
| e.g. http.sslVerify: 'false' | |
| OR 'url."https://api:\${TOKEN}@github.com/".insteadOf': 'https://github.com/' | |
featureRepoPath string |
FeatureRepoPath is the relative path to the feature repo subdirectory. Default is 'feature_repo'. |
env EnvVar |
|
envFrom EnvFromSource |
JobSpec describes how the job execution will look like.
Appears in:
| Field | Description |
|---|---|
parallelism integer |
Specifies the maximum desired number of pods the job should |
| run at any given time. The actual number of pods running in steady state will | |
| be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), | |
| i.e. when the work left to do is less than max parallelism. | |
| More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | |
completions integer |
Specifies the desired number of successfully finished pods the |
| job should be run with. Setting to null means that the success of any | |
| pod signals the success of all pods, and allows parallelism to have any positive | |
| value. Setting to 1 means that parallelism is limited to 1 and the success of that | |
| pod signals the success of the job. | |
| More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | |
activeDeadlineSeconds integer |
Specifies the duration in seconds relative to the startTime that the job |
| may be continuously active before the system tries to terminate it; value | |
| must be positive integer. If a Job is suspended (at creation or through an | |
| update), this timer will effectively be stopped and reset when the Job is | |
| resumed again. | |
podFailurePolicy PodFailurePolicy |
Specifies the policy of handling failed pods. In particular, it allows to |
| specify the set of actions and conditions which need to be | |
| satisfied to take the associated action. | |
| If empty, the default behaviour applies - the counter of failed pods, | |
| represented by the jobs's .status.failed field, is incremented and it is | |
| checked against the backoffLimit. This field cannot be used in combination | |
| with restartPolicy=OnFailure. |
This field is beta-level. It can be used when the JobPodFailurePolicy
feature gate is enabled (enabled by default). |
| backoffLimit integer | Specifies the number of retries before marking this job failed. |
| backoffLimitPerIndex integer | Specifies the limit for the number of retries within an
index before marking this index as failed. When enabled the number of
failures per index is kept in the pod's
batch.kubernetes.io/job-index-failure-count annotation. It can only
be set when Job's completionMode=Indexed, and the Pod's restart
policy is Never. The field is immutable.
This field is beta-level. It can be used when the JobBackoffLimitPerIndex
feature gate is enabled (enabled by default). |
| maxFailedIndexes integer | Specifies the maximal number of failed indexes before marking the Job as
failed, when backoffLimitPerIndex is set. Once the number of failed
indexes exceeds this number the entire Job is marked as Failed and its
execution is terminated. When left as null the job continues execution of
all of its indexes and is marked with the Complete Job condition.
It can only be specified when backoffLimitPerIndex is set.
It can be null or up to completions. It is required and must be
less than or equal to 10^4 when is completions greater than 10^5.
This field is beta-level. It can be used when the JobBackoffLimitPerIndex
feature gate is enabled (enabled by default). |
| ttlSecondsAfterFinished integer | ttlSecondsAfterFinished limits the lifetime of a Job that has finished
execution (either Complete or Failed). If this field is set,
ttlSecondsAfterFinished after the Job finishes, it is eligible to be
automatically deleted. When the Job is being deleted, its lifecycle
guarantees (e.g. finalizers) will be honored. If this field is unset,
the Job won't be automatically deleted. If this field is set to zero,
the Job becomes eligible to be deleted immediately after it finishes. |
| completionMode CompletionMode | completionMode specifies how Pod completions are tracked. It can be
NonIndexed (default) or Indexed.
NonIndexed means that the Job is considered complete when there have
been .spec.completions successfully completed Pods. Each Pod completion is
homologous to each other.
Indexed means that the Pods of a
Job get an associated completion index from 0 to (.spec.completions - 1),
available in the annotation batch.kubernetes.io/job-completion-index.
The Job is considered complete when there is one successfully completed Pod
for each index.
When value is Indexed, .spec.completions must be specified and
.spec.parallelism must be less than or equal to 10^5.
In addition, The Pod name takes the form
$(job-name)-$(index)-$(random-string),
the Pod hostname takes the form $(job-name)-$(index).
More completion modes can be added in the future.
If the Job controller observes a mode that it doesn't recognize, which
is possible during upgrades due to version skew, the controller
skips updates for the Job. |
| suspend boolean | suspend specifies whether the Job controller should create Pods or not. If
a Job is created with suspend set to true, no Pods are created by the Job
controller. If a Job is suspended after creation (i.e. the flag goes from
false to true), the Job controller will delete all active Pods associated
with this Job. Users must design their workload to gracefully handle this.
Suspending a Job will reset the StartTime field of the Job, effectively
resetting the ActiveDeadlineSeconds timer too. |
| podReplacementPolicy PodReplacementPolicy | podReplacementPolicy specifies when to create replacement Pods.
Possible values are:
- TerminatingOrFailed means that we recreate pods when they are terminating (has a metadata.deletionTimestamp) or failed.
- Failed means to wait until a previously created Pod is fully terminated (has phase Failed or Succeeded) before creating a replacement Pod.
When using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is an beta field. To use this, enable the JobPodReplacementPolicy feature toggle. This is on by default. |
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. |