Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md and remove versions from Helm Charts #457

Merged
merged 2 commits into from
Feb 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,29 @@ my_model = ml.fit(data)
prediction = my_model.predict(fs.get_online_features(customer_features, customer_entities))
```

## Getting Started with Docker Compose
The following commands will start Feast in online-only mode.
```
git clone https://github.com/gojek/feast.git
cd feast/infra/docker-compose
cp .env.sample .env
docker-compose up -d
```

A [Jupyter Notebook](http://localhost:8888/tree/feast/examples) is now available to start using Feast.

Please see the links below to set up Feast for batch/historical serving with BigQuery.

## Important resources

Please refer to the official docs at <https://feast.dev>
Please refer to the official documentation at <https://docs.feast.dev>

* [Why Feast?](https://docs.feast.dev/why-feast)
* [Concepts](https://docs.feast.dev/concepts)
* [Installation](https://docs.feast.dev/getting-started/installing-feast)
* [Getting Help](https://docs.feast.dev/getting-help)
* [Example Notebook](https://github.com/gojek/feast/blob/master/examples/basic/basic.ipynb)
* [Installation](https://docs.feast.dev/installing-feast/overview)
* [Examples](https://github.com/gojek/feast/blob/master/examples/)
* [Change Log](https://github.com/gojek/feast/blob/master/CHANGELOG.md)
* [Slack (#Feast)](https://join.slack.com/t/kubeflow/shared_invite/enQtNDg5MTM4NTQyNjczLTdkNTVhMjg1ZTExOWI0N2QyYTQ2MTIzNTJjMWRiOTFjOGRlZWEzODc1NzMwNTMwM2EzNjY1MTFhODczNjk4MTk)

## Notice

Expand Down
6 changes: 3 additions & 3 deletions infra/charts/feast/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ helm repo add feast-charts https://feast-charts.storage.googleapis.com
helm repo update
```

Install Feast release with minimal features, without batch serving and persistency:
Install Feast release with minimal features, without batch serving and persistence:
```bash
RELEASE_NAME=demo
helm install feast-charts/feast --name $RELEASE_NAME --version 0.3.2 -f values-demo.yaml
helm install feast-charts/feast --name $RELEASE_NAME -f values-demo.yaml
```

Install Feast release for typical use cases, with batch and online serving:
Expand All @@ -60,7 +60,7 @@ PROJECT_ID=google-cloud-project-id
DATASET_ID=bigquery-dataset-id

# Install the Helm release using default values.yaml
helm install feast-charts/feast --name feast --version 0.3.2 \
helm install feast-charts/feast --name feast \
--set feast-serving-batch."application\.yaml".feast.jobs.staging-location=$STAGING_LOCATION \
--set feast-serving-batch."store\.yaml".bigquery_config.project_id=$PROJECT_ID \
--set feast-serving-batch."store\.yaml".bigquery_config.dataset_id=$DATASET_ID
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ spec:

containers:
- name: {{ .Chart.Name }}
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
image: '{{ .Values.image.repository }}:{{ required "No .image.tag found. This must be provided as input." .Values.image.tag }}'
imagePullPolicy: {{ .Values.image.pullPolicy }}

volumeMounts:
Expand Down
1 change: 0 additions & 1 deletion infra/charts/feast/charts/feast-core/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ replicaCount: 1
# image configures the Docker image for Feast Core
image:
repository: gcr.io/kf-feast/feast-core
tag: 0.3.2
pullPolicy: IfNotPresent

# application.yaml is the main configuration for Feast Core application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ spec:

containers:
- name: {{ .Chart.Name }}
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
image: '{{ .Values.image.repository }}:{{ required "No .image.tag found. This must be provided as input." .Values.image.tag }}'
imagePullPolicy: {{ .Values.image.pullPolicy }}

volumeMounts:
Expand Down
1 change: 0 additions & 1 deletion infra/charts/feast/charts/feast-serving/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ replicaCount: 1
# image configures the Docker image for Feast Serving
image:
repository: gcr.io/kf-feast/feast-serving
tag: 0.3.2
pullPolicy: IfNotPresent

# application.yaml is the main configuration for Feast Serving application.
Expand Down
6 changes: 3 additions & 3 deletions infra/charts/feast/requirements.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
dependencies:
- name: feast-core
version: 0.3.2
version: 0.4.4
condition: feast-core.enabled
- name: feast-serving
alias: feast-serving-batch
version: 0.3.2
version: 0.4.4
condition: feast-serving-batch.enabled
- name: feast-serving
alias: feast-serving-online
version: 0.3.2
version: 0.4.4
condition: feast-serving-online.enabled
12 changes: 6 additions & 6 deletions infra/charts/feast/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@
# of Feast Serving: online and batch will be deployed. Both described
# using the same chart "feast-serving".
#
# The following are default values for typical Feast deployment, but not
# for production setting. Refer to "values-production.yaml" for recommended
# values in production environment.
#
# Note that the import job by default uses DirectRunner
# https://beam.apache.org/documentation/runners/direct/
# in this configuration since it allows Feast to run in more environments
Expand Down Expand Up @@ -45,16 +41,18 @@
# ============================================================

feast-core:
# enabled specifies whether to install Feast Core component.
# If enabled specifies whether to install Feast Core component.
#
# Normally, this is set to "false" when Feast users need access to low latency
# Feast Serving, by deploying multiple instances of Feast Serving closest
# to the client. These instances of Feast Serving however can still use
# the same shared Feast Core.
enabled: true
# Specify what image tag to use. Keep this consistent for all components

# Specify which image tag to use. Keep this consistent for all components
image:
tag: "0.4.4"

# jvmOptions are options that will be passed to the Java Virtual Machine (JVM)
# running Feast Core.
#
Expand All @@ -63,13 +61,15 @@ feast-core:
jvmOptions:
- -Xms1024m
- -Xmx1024m

# resources that should be allocated to Feast Core.
resources:
requests:
cpu: 1000m
memory: 1024Mi
limits:
memory: 2048Mi

# gcpServiceAccount is the Google service account that Feast Core will use.
gcpServiceAccount:
# useExistingSecret specifies Feast to use an existing secret containing
Expand Down