From ff9bb75283cbb2a61a0add8a852ce4c9cfac4ddd Mon Sep 17 00:00:00 2001 From: Willem Pienaar <6728866+woop@users.noreply.github.com> Date: Mon, 3 Feb 2020 15:27:48 +0800 Subject: [PATCH] Update README.md and remove versions from Helm Charts (#457) * Update README.md and remove versions from Helm Charts * Fix type in README.md --- README.md | 22 +++++++++++++++---- infra/charts/feast/README.md | 6 ++--- .../feast-core/templates/deployment.yaml | 2 +- .../feast/charts/feast-core/values.yaml | 1 - .../feast-serving/templates/deployment.yaml | 2 +- .../feast/charts/feast-serving/values.yaml | 1 - infra/charts/feast/requirements.yaml | 6 ++--- infra/charts/feast/values.yaml | 12 +++++----- 8 files changed, 32 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index fb36f6cabc..bf0dedecb4 100644 --- a/README.md +++ b/README.md @@ -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 +Please refer to the official documentation at * [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 diff --git a/infra/charts/feast/README.md b/infra/charts/feast/README.md index 0463a9a3f8..ab5321ca86 100644 --- a/infra/charts/feast/README.md +++ b/infra/charts/feast/README.md @@ -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: @@ -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 diff --git a/infra/charts/feast/charts/feast-core/templates/deployment.yaml b/infra/charts/feast/charts/feast-core/templates/deployment.yaml index 02a533c263..0671d9574b 100644 --- a/infra/charts/feast/charts/feast-core/templates/deployment.yaml +++ b/infra/charts/feast/charts/feast-core/templates/deployment.yaml @@ -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: diff --git a/infra/charts/feast/charts/feast-core/values.yaml b/infra/charts/feast/charts/feast-core/values.yaml index 321d71c844..f746bc96ea 100644 --- a/infra/charts/feast/charts/feast-core/values.yaml +++ b/infra/charts/feast/charts/feast-core/values.yaml @@ -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. diff --git a/infra/charts/feast/charts/feast-serving/templates/deployment.yaml b/infra/charts/feast/charts/feast-serving/templates/deployment.yaml index 5be636df96..e6824a2346 100644 --- a/infra/charts/feast/charts/feast-serving/templates/deployment.yaml +++ b/infra/charts/feast/charts/feast-serving/templates/deployment.yaml @@ -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: diff --git a/infra/charts/feast/charts/feast-serving/values.yaml b/infra/charts/feast/charts/feast-serving/values.yaml index d489a48748..d2b3c59947 100644 --- a/infra/charts/feast/charts/feast-serving/values.yaml +++ b/infra/charts/feast/charts/feast-serving/values.yaml @@ -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. diff --git a/infra/charts/feast/requirements.yaml b/infra/charts/feast/requirements.yaml index ed280d64b6..5416ded3fe 100644 --- a/infra/charts/feast/requirements.yaml +++ b/infra/charts/feast/requirements.yaml @@ -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 diff --git a/infra/charts/feast/values.yaml b/infra/charts/feast/values.yaml index db3ec44f33..f9a0a76dc1 100644 --- a/infra/charts/feast/values.yaml +++ b/infra/charts/feast/values.yaml @@ -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 @@ -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. # @@ -63,6 +61,7 @@ feast-core: jvmOptions: - -Xms1024m - -Xmx1024m + # resources that should be allocated to Feast Core. resources: requests: @@ -70,6 +69,7 @@ feast-core: 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