Skip to content

Commit 4e86bdf

Browse files
docs: Add dedicated Feast on Kubernetes page (#5781)
docs: add dedicated Feast on Kubernetes page Signed-off-by: antznette1 <[email protected]> Co-authored-by: Francisco Javier Arceo <[email protected]>
1 parent 6afd353 commit 4e86bdf

File tree

3 files changed

+73
-48
lines changed

3 files changed

+73
-48
lines changed

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@
6868
* [Scaling Feast](how-to-guides/scaling-feast.md)
6969
* [Structuring Feature Repos](how-to-guides/structuring-repos.md)
7070
* [Running Feast in production (e.g. on Kubernetes)](how-to-guides/running-feast-in-production.md)
71+
* [Feast on Kubernetes](how-to-guides/feast-on-kubernetes.md)
7172
* [Customizing Feast](how-to-guides/customizing-feast/README.md)
7273
* [Adding a custom batch materialization engine](how-to-guides/customizing-feast/creating-a-custom-materialization-engine.md)
7374
* [Adding a new offline store](how-to-guides/customizing-feast/adding-a-new-offline-store.md)
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Feast on Kubernetes
2+
3+
This page covers deploying Feast on Kubernetes, including the Feast Operator and feature servers.
4+
5+
## Overview
6+
7+
Kubernetes is a common target environment for running Feast in production. You can use Kubernetes to:
8+
9+
1. Run Feast feature servers for online feature retrieval.
10+
2. Run scheduled and ad-hoc jobs (e.g. materialization jobs) as Kubernetes Jobs.
11+
3. Operate Feast components using Kubernetes-native primitives.
12+
13+
## Feast Operator
14+
15+
To deploy Feast components on Kubernetes, use the included [feast-operator](../../infra/feast-operator).
16+
17+
For first-time Operator users, it may be a good exercise to try the [Feast Operator Quickstart](../../examples/operator-quickstart). The quickstart demonstrates some of the Operator's built-in features, e.g. git repos, `feast apply` jobs, etc.
18+
19+
## Deploy Feast feature servers on Kubernetes
20+
21+
{% embed url="https://www.youtube.com/playlist?list=PLPzVNzik7rsAN-amQLZckd0so3cIr7blX" %}
22+
23+
**Basic steps**
24+
25+
1. Install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
26+
2. Install the Operator
27+
28+
Install the latest release:
29+
30+
```sh
31+
kubectl apply -f https://raw.githubusercontent.com/feast-dev/feast/refs/heads/stable/infra/feast-operator/dist/install.yaml
32+
```
33+
34+
OR, install a specific version:
35+
36+
```sh
37+
kubectl apply -f https://raw.githubusercontent.com/feast-dev/feast/refs/tags/<version>/infra/feast-operator/dist/install.yaml
38+
```
39+
40+
3. Deploy a Feature Store
41+
42+
```sh
43+
kubectl apply -f https://raw.githubusercontent.com/feast-dev/feast/refs/heads/stable/infra/feast-operator/config/samples/v1_featurestore.yaml
44+
```
45+
46+
Verify the status:
47+
48+
```sh
49+
$ kubectl get feast
50+
NAME STATUS AGE
51+
sample Ready 2m21s
52+
```
53+
54+
The above will install a simple [FeatureStore CR](../../infra/feast-operator/docs/api/markdown/ref.md) like the following. By default, it will run the [Online Store feature server](../reference/feature-servers/python-feature-server.md):
55+
56+
```yaml
57+
apiVersion: feast.dev/v1
58+
kind: FeatureStore
59+
metadata:
60+
name: sample
61+
spec:
62+
feastProject: my_project
63+
```
64+
65+
> _More advanced FeatureStore CR examples can be found in the feast-operator [samples directory](../../infra/feast-operator/config/samples)._
66+
67+
{% hint style="success" %}
68+
Important note: Scaling a Feature Store Deployment should only be done if the configured data store(s) will support it.
69+
70+
Please check the how-to guide for some specific recommendations on [how to scale Feast](./scaling-feast.md).
71+
{% endhint %}

docs/how-to-guides/running-feast-in-production.md

Lines changed: 1 addition & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -204,54 +204,7 @@ feature_vector = fs.get_online_features(
204204
```
205205

206206
### 4.2. Deploy Feast feature servers on Kubernetes
207-
208-
To deploy a Feast feature server on Kubernetes, you should use the included [feast-operator](../../infra/feast-operator).
209-
210-
{% embed url="https://www.youtube.com/playlist?list=PLPzVNzik7rsAN-amQLZckd0so3cIr7blX" %}
211-
212-
**Basic steps**
213-
1. Install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
214-
2. Install the Operator
215-
216-
217-
Install the latest release
218-
```sh
219-
kubectl apply -f https://raw.githubusercontent.com/feast-dev/feast/refs/heads/stable/infra/feast-operator/dist/install.yaml
220-
```
221-
222-
OR, install a specific version -
223-
```
224-
kubectl apply -f https://raw.githubusercontent.com/feast-dev/feast/refs/tags/<version>/infra/feast-operator/dist/install.yaml
225-
```
226-
227-
3. Deploy a Feature Store
228-
229-
```sh
230-
kubectl apply -f https://raw.githubusercontent.com/feast-dev/feast/refs/heads/stable/infra/feast-operator/config/samples/v1_featurestore.yaml
231-
```
232-
Verify the status
233-
```
234-
$ kubectl get feast
235-
NAME STATUS AGE
236-
sample Ready 2m21s
237-
```
238-
239-
The above will install a simple [FeatureStore CR](../../infra/feast-operator/docs/api/markdown/ref.md) like the following. By default, it will run the [Online Store feature server](../reference/feature-servers/python-feature-server.md) -
240-
```yaml
241-
apiVersion: feast.dev/v1
242-
kind: FeatureStore
243-
metadata:
244-
name: sample
245-
spec:
246-
feastProject: my_project
247-
```
248-
> _More advanced FeatureStore CR examples can be found in the feast-operator [samples directory](../../infra/feast-operator/config/samples)._
249-
250-
For first-time Operator users, it may be a good exercise to try the [Feast Operator Quickstart](../../examples/operator-quickstart). The quickstart will demonstrate some of the Operator's built-in features, e.g. git repos, `feast apply` jobs, etc.
251-
252-
{% hint style="success" %} Important note: Scaling a Feature Store Deployment should only be done if the configured data store(s) will support it.
253-
254-
Please check the how-to guide for some specific recommendations on [how to scale Feast](./scaling-feast.md). {% endhint %}
207+
See [Feast on Kubernetes](./feast-on-kubernetes.md).
255208

256209
## 5. Using environment variables in your yaml configuration
257210

0 commit comments

Comments
 (0)