Skip to content

Commit 69d1f46

Browse files
Zhu Zhanyangitbook-bot
authored andcommitted
GitBook: [master] one page modified
1 parent c9eb264 commit 69d1f46

1 file changed

Lines changed: 37 additions & 14 deletions

File tree

docs/reference/configuration-reference.md

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,31 @@
22

33
## 1. Overview
44

5-
Details how to configure each Feast component
5+
The Configuration Reference will walk through how to configure each Feast component:
66

7-
* Feast Core, Serving and Job Controller
8-
* Feast CLI and Feast Python SDK
7+
* [Feast Core, Serving and Job Controller](configuration-reference.md#2-feast-core-serving-and-job-controller)
8+
* [Feast CLI and Feast Python SDK](configuration-reference.md#3-feast-cli-and-feast-python-sdk)
9+
* [Feast Go and Java SDK](configuration-reference.md#4-feast-java-and-go-sdk)
910

10-
## 2. Feast Core, Serving and Job Controller
11+
## [2. Feast Core, Serving and Job Controller](configuration-reference.md#3-feast-cli-and-feast-python-sdk)
1112

12-
Available Configuration Properties for Feast Core, Serving and Job Controller can be found in the corresponding `application.yml` of each component:
13+
Available Configuration Properties for Feast Core, Serving and Job Controller can be referenced from the corresponding `application.yml` of each component:
1314

1415
| Component | Configuration Reference |
1516
| :--- | :--- |
16-
| Core | [core/src/main/resources/application.yml](https://github.com/feast-dev/feast/blob/master/infra/docker-compose/core/core.yml) |
17+
| Core | [core/src/main/resources/application.yml](https://github.com/feast-dev/feast/blob/master/core/src/main/resources/application.yml) |
1718
| Serving \(Online/Historical\) | [serving/src/main/resources/application.yml](https://github.com/feast-dev/feast/blob/master/serving/src/main/resources/application.yml) |
1819
| Job Controller | [job-controller/src/main/resources/application.yml](https://github.com/feast-dev/feast/blob/master/job-controller/src/main/resources/application.yml) |
1920

2021
Configuration Properties for Feast Core, Serving and Job Controller are defined depending on Feast is deployed:
2122

22-
* Docker Compose deployment - Feast is deployed with Docker Compose.
23-
* Kubernetes deployment - Feast is deployed with Kubernetes.
24-
* Direct Configuration - Feast is built and run from source code.
23+
* [Docker Compose deployment](configuration-reference.md#docker-compose-deployment) - Feast is deployed with Docker Compose.
24+
* [Kubernetes deployment](configuration-reference.md#kubernetes-deployment) - Feast is deployed with Kubernetes.
25+
* [Direct Configuration](configuration-reference.md#direct-configuration) - Feast is built and run from source code.
2526

2627
### Docker Compose Deployment
2728

28-
Configuration Properties can be set for each Feast component deployed using docker compose at:
29+
Configuration Properties from `application.yml` can be set for each Feast component deployed using docker compose at:
2930

3031
| Component | Configuration Path |
3132
| :--- | :--- |
@@ -51,10 +52,10 @@ feast-core:
5152
A reference of the sub chart specific configuration can found in its `values.yml`:
5253

5354
* [feast-core](https://github.com/feast-dev/feast/blob/master/infra/charts/feast/charts/feast-core)
54-
* [feast-serving](https://github.com/feast-dev/feast/blob/master/infra/charts/feast/feast-serving)
55+
* [feast-serving](https://github.com/feast-dev/feast/tree/master/infra/charts/feast/charts/feast-serving)
5556
* [feast-jobcontroller](https://github.com/feast-dev/feast/blob/master/infra/charts/feast/charts/feast-jobcontroller)
5657

57-
Configuration Properties can be set via `application-override.yaml` for each component in `values.yml`:
58+
Configuration Properties can be set via `application-override.yaml` for each component in `values.yaml`:
5859

5960
```yaml
6061
# values.yaml
@@ -65,15 +66,15 @@ feast-core:
6566
# ...
6667
```
6768

68-
Futher documentation on configuring Feast via the Kubernetes deployment can be found in the[ Helm Chart Readme.](https://github.com/feast-dev/feast/blob/master/infra/charts/feast/README.md)
69+
[Learn more ](https://github.com/feast-dev/feast/blob/master/infra/charts/feast/README.md)about configuring the Feast Helm Chart[.](https://github.com/feast-dev/feast/blob/master/infra/charts/feast/README.md)
6970

7071
### Direct Configuration
7172

7273
If Feast is built and running from source, configuration Properties can be set directly in the Feast component's `application.yml`:
7374

7475
| Component | Configuration Path |
7576
| :--- | :--- |
76-
| Core | [core/src/main/resources/application.yml](https://github.com/feast-dev/feast/blob/master/infra/docker-compose/core/core.yml) |
77+
| Core | [core/src/main/resources/application.yml](https://github.com/feast-dev/feast/blob/master/core/src/main/resources/application.yml) |
7778
| Serving \(Online/Historical\) | [serving/src/main/resources/application.yml](https://github.com/feast-dev/feast/blob/master/serving/src/main/resources/application.yml) |
7879
| Job Controller | [job-controller/src/main/resources/application.yml](https://github.com/feast-dev/feast/blob/master/job-controller/src/main/resources/application.yml) |
7980

@@ -112,3 +113,25 @@ core_url = localhost:6565
112113

113114
Available configuration options for Python SDK/CLI be found [here](https://github.com/feast-dev/feast/blob/master/sdk/python/feast/constants.py).
114115

116+
## 4. Feast Java and Go SDK
117+
118+
The Feast Java and Go SDK is configured via arguments passed when instantiating the Feast Client:
119+
120+
* Go SDK
121+
122+
```go
123+
// configure serving host and port.
124+
cli := feast.NewGrpcClient("localhost", 6566)
125+
```
126+
127+
Available configuration parameters can be found in the[ Go SDK API reference.](https://godoc.org/github.com/feast-dev/feast/sdk/go)
128+
129+
* Java SDK
130+
131+
```java
132+
// configure serving host and port.
133+
client = FeastClient.create(servingHost, servingPort);
134+
```
135+
136+
Available configuration parameters can be found in the [Java SDK API reference.](https://javadoc.io/doc/dev.feast/feast-sdk/latest/com/gojek/feast/package-summary.html)
137+

0 commit comments

Comments
 (0)