fix helm docs and accidental issues

Signed-off-by: Danny Chiao <danny@tecton.ai>
feast-dev · feast-ci-bot · Aug 19, 2022 · Aug 18, 2022 · Aug 18, 2022 · Aug 18, 2022
commit 47a7a966567ae6e7b1578c34613290af4f3a3189
@@ -9,19 +9,19 @@ feature-server:
               config:
                 host: my-redis-master
                 port: 6379
-                password: YTVWvjrQcK
+                password: [YOUR PASSWORD]
             entityKeySerializationVersion: 2
     # Uncomment below for dev
-    image:
-      tag: dev
+#    image:
+#      tag: dev
 
 # Uncomment below for dev
-transformation-service:
-  image:
-    tag: dev
+#transformation-service:
+#  image:
+#    tag: dev
 
 global:
   registry:
-    path: gs://danny-test-feast-bucket/demo-repo/registry.db
+    path: gs://[YOUR GCS BUCKET]/demo-repo/registry.db
     cache_ttl_seconds: 60
   project: feast_java_demo
@@ -1,9 +1,9 @@
-registry: gs://danny-test-feast-bucket/demo-repo/registry.db
+registry: gs://[YOUR GCS BUCKET]/demo-repo/registry.db
 project: feast_java_demo
 provider: gcp
 online_store:
   type: redis
-  connection_string: localhost:6379,password=YTVWvjrQcK
+  connection_string: localhost:6379,password=[YOUR PASSWORD]
 offline_store:
   type: file
 entity_key_serialization_version: 2
@@ -1,14 +1,46 @@
-# feast-feature-server
+# Feast Python / Go Feature Server Helm Charts
 
-![Version: 0.23.0](https://img.shields.io/badge/Version-0.23.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
+## Chart: Feast Feature Server in Go or Python
 
-Feast Feature Server in Go or Python
+Feast Feature Server in Go or Python Current chart version is `0.23.0`
 
-**Homepage:** <https://feast.dev/>
+## Installation
+Docker repository and tag are required. Helm install example:
+```
+helm install feast-python-server . --set image.repository=REPO --set image.tag=TAG
+```
 
-## Source Code
+Deployment assumes that `feature_store.yaml` exists on docker image. Example docker image:
+```
+FROM python:3.8
 
-* <https://github.com/feast-dev/feast>
+RUN apt update && \
+    apt install -y jq
+
+RUN pip install pip --upgrade
+
+RUN pip install feast
+
+COPY feature_store.yaml /feature_store.yaml
+```
+
+Furthermore, if you wish to use the Go feature server, then you must install the Apache Arrow C++ libraries, and your `feature_store.yaml` should include `go_feature_server: True`.
+ For more details, see the [docs](https://docs.feast.dev/reference/feature-servers/go-feature-server).
+ The docker image might look like:
+ ```
+ FROM python:3.8
+ RUN apt update && \
+     apt install -y jq
+ RUN pip install pip --upgrade
+ RUN pip install feast
+ RUN apt update
+ RUN apt install -y -V ca-certificates lsb-release wget
+ RUN wget https://apache.jfrog.io/artifactory/arrow/$(lsb_release --id --short | tr 'A-Z' 'a-z')/apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb
+ RUN apt install -y -V ./apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb
+ RUN apt update
+ RUN apt -y install libarrow-dev
+ COPY feature_store.yaml /feature_store.yaml
+ ```
 
 ## Values
 
@@ -17,8 +49,8 @@ Feast Feature Server in Go or Python
 | affinity | object | `{}` |  |
 | fullnameOverride | string | `""` |  |
 | image.pullPolicy | string | `"IfNotPresent"` |  |
-| image.repository | string | `""` |  |
-| image.tag | string | `""` |  |
+| image.repository | string | `""` | [required] The repository for the Docker image |
+| image.tag | string | `""` | [required] The Docker image tag |
 | imagePullSecrets | list | `[]` |  |
 | livenessProbe.initialDelaySeconds | int | `30` |  |
 | livenessProbe.periodSeconds | int | `30` |  |
@@ -33,7 +65,4 @@ Feast Feature Server in Go or Python
 | securityContext | object | `{}` |  |
 | service.port | int | `80` |  |
 | service.type | string | `"ClusterIP"` |  |
-| tolerations | list | `[]` |  |
-
-----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+| tolerations | list | `[]` |  |
@@ -0,0 +1,47 @@
+# Feast Python / Go Feature Server Helm Charts
+
+## Chart: Feast Feature Server in Go or Python
+
+{{ template "chart.description" . }} Current chart version is `{{ template "chart.version" . }}`
+
+## Installation
+Docker repository and tag are required. Helm install example:
+```
+helm install feast-python-server . --set image.repository=REPO --set image.tag=TAG
+```
+
+Deployment assumes that `feature_store.yaml` exists on docker image. Example docker image:
+```
+FROM python:3.8
+
+RUN apt update && \
+    apt install -y jq
+
+RUN pip install pip --upgrade
+
+RUN pip install feast
+
+COPY feature_store.yaml /feature_store.yaml
+```
+
+Furthermore, if you wish to use the Go feature server, then you must install the Apache Arrow C++ libraries, and your `feature_store.yaml` should include `go_feature_server: True`.
+ For more details, see the [docs](https://docs.feast.dev/reference/feature-servers/go-feature-server).
+ The docker image might look like:
+ ```
+ FROM python:3.8
+ RUN apt update && \
+     apt install -y jq
+ RUN pip install pip --upgrade
+ RUN pip install feast
+ RUN apt update
+ RUN apt install -y -V ca-certificates lsb-release wget
+ RUN wget https://apache.jfrog.io/artifactory/arrow/$(lsb_release --id --short | tr 'A-Z' 'a-z')/apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb
+ RUN apt install -y -V ./apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb
+ RUN apt update
+ RUN apt -y install libarrow-dev
+ COPY feature_store.yaml /feature_store.yaml
+ ```
+
+{{ template "chart.requirementsSection" . }}
+
+{{ template "chart.valuesSection" . }}
@@ -5,8 +5,10 @@
 replicaCount: 1
 
 image:
+  # image.repository -- [required] The repository for the Docker image
   repository: ""
   pullPolicy: IfNotPresent
+  # image.tag -- [required] The Docker image tag
   tag: ""
 
 imagePullSecrets: []

@@ -1,14 +1,28 @@
-# feast-python-server
+# Feast Python Feature Server Helm Charts
+
+## Chart: Feast
 
-![Version: 0.23.0](https://img.shields.io/badge/Version-0.23.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
+Feast Feature Server in Python Current chart version is `0.23.0`
 
-Feast Feature Server in Python
+## Installation
+Docker repository and tag are required. Helm install example:
+```
+helm install feast-python-server . --set image.repository=REPO --set image.tag=TAG
+```
 
-**Homepage:** <https://feast.dev/>
+Deployment assumes that `feature_store.yaml` exists on docker image. Example docker image:
+```
+FROM python:3.8
 
-## Source Code
+RUN apt update && \
+    apt install -y jq
 
-* <https://github.com/feast-dev/feast>
+RUN pip install pip --upgrade
+
+RUN pip install feast
+
+COPY feature_store.yaml /feature_store.yaml
+```
 
 ## Values
 
@@ -17,8 +31,8 @@ Feast Feature Server in Python
 | affinity | object | `{}` |  |
 | fullnameOverride | string | `""` |  |
 | image.pullPolicy | string | `"IfNotPresent"` |  |
-| image.repository | string | `""` |  |
-| image.tag | string | `""` |  |
+| image.repository | string | `""` | [required] The repository for the Docker image |
+| image.tag | string | `""` | [required] The Docker image tag |
 | imagePullSecrets | list | `[]` |  |
 | livenessProbe.initialDelaySeconds | int | `30` |  |
 | livenessProbe.periodSeconds | int | `30` |  |
@@ -33,7 +47,4 @@ Feast Feature Server in Python
 | securityContext | object | `{}` |  |
 | service.port | int | `80` |  |
 | service.type | string | `"ClusterIP"` |  |
-| tolerations | list | `[]` |  |
-
-----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+| tolerations | list | `[]` |  |
@@ -0,0 +1,29 @@
+# Feast Python Feature Server Helm Charts
+
+## Chart: Feast
+
+{{ template "chart.description" . }} Current chart version is `{{ template "chart.version" . }}`
+
+## Installation
+Docker repository and tag are required. Helm install example:
+```
+helm install feast-python-server . --set image.repository=REPO --set image.tag=TAG
+```
+
+Deployment assumes that `feature_store.yaml` exists on docker image. Example docker image:
+```
+FROM python:3.8
+
+RUN apt update && \
+    apt install -y jq
+
+RUN pip install pip --upgrade
+
+RUN pip install feast
+
+COPY feature_store.yaml /feature_store.yaml
+```
+
+{{ template "chart.requirementsSection" . }}
+
+{{ template "chart.valuesSection" . }}
@@ -5,8 +5,10 @@
 replicaCount: 1
 
 image:
+  # image.repository -- [required] The repository for the Docker image
   repository: ""
   pullPolicy: IfNotPresent
+  # image.tag -- [required] The Docker image tag
   tag: ""
 
 imagePullSecrets: []