Skip to content

Commit f74a892

Browse files
committed
Add more details to the README.md
1 parent d5b02af commit f74a892

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

README.md

+35-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Feast Java components
2+
[![complete](https://github.com/feast-dev/feast-java/actions/workflows/complete.yml/badge.svg)](https://github.com/feast-dev/feast-java/actions/workflows/complete.yml)
23

34
## Overview
45

@@ -10,4 +11,37 @@ This repository contains the following Feast components
1011

1112
# Architecture
1213

13-
![](docs/architecture.png)
14+
![](docs/architecture.png)
15+
16+
17+
* Feast Core has a dependency on Postgres
18+
* Feast Serving has a dependency on an online store (database) for retrieving features (like Redis)
19+
* Feast Serving has a dependency on Feast Core
20+
* The process of ingesting data into the online store (Redis) is decoupled from the process of reading from it. Please see [Feast Spark](https://github.com/feast-dev/feast-spark) for more details about ingesting data into the online store.
21+
* The Go and Python Clients are not a part of this repository.
22+
23+
# Running tests
24+
25+
To run unit tests
26+
27+
```
28+
make test-java
29+
```
30+
31+
To run integration tests
32+
33+
```
34+
make test-java-integration
35+
```
36+
37+
# Building docker images
38+
39+
In order to build development versions of the Core and Serving images, please run the following commands:
40+
41+
```
42+
build-docker REGISTRY=gcr.io/kf-feast VERSION=develop
43+
```
44+
45+
# Installing using Helm
46+
47+
Please see the Helm charts in [charts](infra/charts).

docs/architecture.png

4.43 KB
Loading

0 commit comments

Comments
 (0)