Skip to content

Commit b36dff6

Browse files
davidheryantofeast-ci-bot
davidheryanto
authored and
feast-ci-bot
committed
Add documentation to default values.yaml in Feast chart (#376)
1 parent 7571ba7 commit b36dff6

2 files changed

Lines changed: 104 additions & 1 deletion

File tree

‎infra/charts/feast/charts/feast-serving/values.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ application.yaml:
107107
# store.yaml will be mounted in the container.
108108
springConfigMountPath: /etc/feast/feast-serving
109109

110-
# gcpServiceAccount is the service account that Feast Core will use.
110+
# gcpServiceAccount is the service account that Feast Serving will use.
111111
gcpServiceAccount:
112112
# useExistingSecret specifies Feast to use an existing secret containing Google
113113
# Cloud service account JSON key file.

‎infra/charts/feast/values.yaml‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,61 +39,164 @@
3939
# --from-file=/home/user/key.json
4040
#
4141

42+
# ============================================================
43+
# Feast Core
44+
# ============================================================
45+
4246
feast-core:
47+
# enabled specifies whether to install Feast Core component.
48+
#
49+
# Normally, this is set to "false" when Feast users need access to low latency
50+
# Feast Serving, by deploying multiple instances of Feast Serving closest
51+
# to the client. These instances of Feast Serving however can still use
52+
# the same shared Feast Core.
4353
enabled: true
54+
# jvmOptions are options that will be passed to the Java Virtual Machine (JVM)
55+
# running Feast Core.
56+
#
57+
# For example, it is good practice to set min and max heap size in JVM.
58+
# https://stackoverflow.com/questions/6902135/side-effect-for-increasing-maxpermsize-and-max-heap-size
4459
jvmOptions:
4560
- -Xms1024m
4661
- -Xmx1024m
62+
# resources that should be allocated to Feast Core.
4763
resources:
4864
requests:
4965
cpu: 1000m
5066
memory: 1024Mi
67+
limits:
68+
memory: 2048Mi
69+
# gcpServiceAccount is the Google service account that Feast Core will use.
5170
gcpServiceAccount:
71+
# useExistingSecret specifies Feast to use an existing secret containing
72+
# Google Cloud service account JSON key file.
73+
#
74+
# This is the only supported option for now to use a service account JSON.
75+
# Feast admin is expected to create this secret before deploying Feast.
5276
useExistingSecret: true
77+
existingSecret:
78+
# name is the secret name of the existing secret for the service account.
79+
name: feast-gcp-service-account
80+
# key is the secret key of the existing secret for the service account.
81+
# key is normally derived from the file name of the JSON key file.
82+
key: key.json
83+
84+
# ============================================================
85+
# Feast Serving Online
86+
# ============================================================
5387

5488
feast-serving-online:
89+
# enabled specifies whether to install Feast Serving Online component.
5590
enabled: true
91+
# redis.enabled specifies whether Redis should be installed as part of Feast Serving.
92+
#
93+
# If enabled is set to "false", Feast admin has to ensure there is an
94+
# existing Redis running outside Feast, that Feast Serving can connect to.
5695
redis:
5796
enabled: true
97+
# jvmOptions are options that will be passed to the Feast Serving JVM.
5898
jvmOptions:
5999
- -Xms1024m
60100
- -Xmx1024m
101+
# resources that should be allocated to Feast Serving.
61102
resources:
62103
requests:
63104
cpu: 500m
64105
memory: 1024Mi
106+
limits:
107+
memory: 2048Mi
108+
# store.yaml is the configuration for Feast Store.
109+
#
110+
# Refer to this link for more description:
111+
# https://github.com/gojek/feast/blob/79eb4ab5fa3d37102c1dca9968162a98690526ba/protos/feast/core/Store.proto
65112
store.yaml:
66113
name: redis
67114
type: REDIS
68115
redis_config:
116+
# If redis.enabled is set to false, Feast admin should uncomment and
117+
# set the host value to an "existing" Redis instance Feast will use as
118+
# online Store.
119+
#
120+
# Else, if redis.enabled is set to true, no additional configuration is
121+
# required.
122+
#
123+
# host: redis-host
69124
port: 6379
70125
subscriptions:
71126
- name: "*"
72127
version: ">0"
73128

129+
# ============================================================
130+
# Feast Serving Batch
131+
# ============================================================
132+
74133
feast-serving-batch:
134+
# enabled specifies whether to install Feast Serving Batch component.
75135
enabled: true
136+
# redis.enabled specifies whether Redis should be installed as part of Feast Serving.
137+
#
138+
# This is usually set to "false" for Feast Serving Batch because the default
139+
# store is BigQuery.
76140
redis:
77141
enabled: false
142+
# jvmOptions are options that will be passed to the Feast Serving JVM.
78143
jvmOptions:
79144
- -Xms1024m
80145
- -Xmx1024m
146+
# resources that should be allocated to Feast Serving.
81147
resources:
82148
requests:
83149
cpu: 500m
84150
memory: 1024Mi
151+
limits:
152+
memory: 2048Mi
153+
# gcpServiceAccount is the service account that Feast Serving will use.
85154
gcpServiceAccount:
155+
# useExistingSecret specifies Feast to use an existing secret containing
156+
# Google Cloud service account JSON key file.
157+
#
158+
# This is the only supported option for now to use a service account JSON.
159+
# Feast admin is expected to create this secret before deploying Feast.
86160
useExistingSecret: true
161+
existingSecret:
162+
# name is the secret name of the existing secret for the service account.
163+
name: feast-gcp-service-account
164+
# key is the secret key of the existing secret for the service account.
165+
# key is normally derived from the file name of the JSON key file.
166+
key: key.json
167+
# application.yaml is the main configuration for Feast Serving application.
168+
#
169+
# Feast Core is a Spring Boot app which uses this yaml configuration file.
170+
# Refer to https://github.com/gojek/feast/blob/79eb4ab5fa3d37102c1dca9968162a98690526ba/serving/src/main/resources/application.yml
171+
# for a complete list and description of the configuration.
87172
application.yaml:
88173
feast:
89174
jobs:
175+
# staging-location specifies the URI to store intermediate files for
176+
# batch serving (required if using BigQuery as Store).
177+
#
178+
# Please set the value to an "existing" Google Cloud Storage URI that
179+
# Feast serving has write access to.
90180
staging-location: gs://bucket/path
181+
# Type of store to store job metadata.
182+
#
183+
# This default configuration assumes that Feast Serving Online is
184+
# enabled as well. So Feast Serving Batch will share the same
185+
# Redis instance to store job statuses.
91186
store-type: REDIS
187+
# store.yaml is the configuration for Feast Store.
188+
#
189+
# Refer to this link for more description:
190+
# https://github.com/gojek/feast/blob/79eb4ab5fa3d37102c1dca9968162a98690526ba/protos/feast/core/Store.proto
92191
store.yaml:
93192
name: bigquery
94193
type: BIGQUERY
95194
bigquery_config:
195+
# project_id specifies the Google Cloud Project. Please set this to the
196+
# project id you are using BigQuery in.
96197
project_id: PROJECT_ID
198+
# dataset_id specifies an "existing" BigQuery dataset Feast Serving Batch
199+
# will use. Please ensure this dataset is created beforehand.
97200
dataset_id: DATASET_ID
98201
subscriptions:
99202
- name: "*"

0 commit comments

Comments
 (0)