Skip to content

Commit

Permalink
Merge pull request feast-dev#15 from redhatHameed/doc-change
Browse files Browse the repository at this point in the history
update the document change and fix teardown function
  • Loading branch information
redhatHameed authored Jun 13, 2024
2 parents dec05c9 + bd9cd79 commit bdf0150
Show file tree
Hide file tree
Showing 6 changed files with 70 additions and 44 deletions.
3 changes: 2 additions & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@
* [PostgreSQL (contrib)](reference/offline-stores/postgres.md)
* [Trino (contrib)](reference/offline-stores/trino.md)
* [Azure Synapse + Azure SQL (contrib)](reference/offline-stores/mssql.md)
* [Remote Offline](reference/offline-stores/remote-offline-store.md)
* [Online stores](reference/online-stores/README.md)
* [Overview](reference/online-stores/overview.md)
* [SQLite](reference/online-stores/sqlite.md)
Expand Down Expand Up @@ -117,7 +118,7 @@
* [Python feature server](reference/feature-servers/python-feature-server.md)
* [\[Alpha\] Go feature server](reference/feature-servers/go-feature-server.md)
* [\[Alpha\] AWS Lambda feature server](reference/feature-servers/alpha-aws-lambda-feature-server.md)
* [Remote Offline Store ](reference/feature-servers/remote-offline-store.md)
* [Offline Feature Server](reference/feature-servers/offline-feature-server)

* [\[Beta\] Web UI](reference/alpha-web-ui.md)
* [\[Alpha\] On demand feature view](reference/alpha-on-demand-feature-view.md)
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/feature-servers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,8 @@ Feast users can choose to retrieve features from a feature server, as opposed to

{% content-ref url="alpha-aws-lambda-feature-server.md" %}
[alpha-aws-lambda-feature-server.md](alpha-aws-lambda-feature-server.md)
{% endcontent-ref %}

{% content-ref url="offline-feature-server.md" %}
[offline-feature-server.md](offline-feature-server.md)
{% endcontent-ref %}
35 changes: 35 additions & 0 deletions docs/reference/feature-servers/offline-feature-server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Offline feature server

## Description

The Offline feature server is an Apache Arrow Flight Server that uses the gRPC communication protocol to exchange data.
This server wraps calls to existing offline store implementations and exposes interfaces as Arrow Flight endpoints.

## How to configure the server

## CLI

There is a CLI command that starts the Offline feature server: `feast serve_offline`. By default, remote offline server uses port 8815, the port can be overridden with a `--port` flag.

## Deploying as a service on Kubernetes

The Offline feature server can be deployed using helm chart see this [helm chart](https://github.com/feast-dev/feast/blob/master/infra/charts/feast-feature-server).

User need to set `feast_mode=offline`, when installing Offline feature server as shown in the helm command below:

```
helm install feast-offline-server feast-charts/feast-feature-server --set feast_mode=offline --set feature_store_yaml_base64=$(base64 > feature_store.yaml)
```

## Server Example

The complete example can be find under [remote-offline-store-example](../../../examples/remote-offline-store)

## How to configure the client

Please see the detail how to configure offline store client [remote-offline-store.md](../offline-stores/remote-offline-store.md)

## Functionality Matrix

The set of functionalities supported by remote offline stores is the same as those supported by offline stores with the SDK, which are described in detail [here](../offline-stores/overview.md#functionality).

42 changes: 0 additions & 42 deletions docs/reference/feature-servers/remote-offline-store.md

This file was deleted.

28 changes: 28 additions & 0 deletions docs/reference/offline-stores/remote-offline-store.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Remote Offline Store

## Description

The Remote Offline Store is an Arrow Flight client for the offline store that implements the `RemoteOfflineStore` class using the existing `OfflineStore` interface.
The client implements various methods, including `get_historical_features`, `pull_latest_from_table_or_query`, `write_logged_features`, and `offline_write_batch`.

## How to configure the client

User needs to create client side `feature_store.yaml` file and set the `offline_store` type `remote` and provide the server connection configuration
including adding the host and specifying the port (default is 8815) required by the Arrow Flight client to connect with the Arrow Flight server.

{% code title="feature_store.yaml" %}
```yaml
offline_store:
type: remote
host: localhost
port: 8815
```
{% endcode %}
## Client Example
The complete example can be find under [remote-offline-store-example](../../../examples/remote-offline-store)
## How to configure the server
Please see the detail how to configure offline feature server [offline-feature-server.md](../feature-servers/offline-feature-server.md)
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ def create_offline_store_config(self) -> FeastConfigBaseModel:

def teardown(self):
super().teardown()
if self.proc is None and self.proc.is_alive():
if self.proc is not None:
self.proc.kill()

# wait server to free the port
Expand Down

0 comments on commit bdf0150

Please sign in to comment.