Merge pull request #10 from stackhpc/refactor/dev-workflow-improvments

Add Tilt-based development workflow

Author: sd109

.gitignore

@@ -3,12 +3,14 @@
 .vscode/
 __pycache__/
 **/*.secret
+.DS_Store
 
 # Ignore local dev helpers
 test-values.y[a]ml
 chart/web-app/settings.yml
 gradio-client-test.py
-venv*/
+**venv*/
+
 
 # Helm chart stuff
 chart/Chart.lock

README.md

@@ -57,3 +57,17 @@ The Helm chart consists of the following components:
 - A frontend web-app built using [Gradio](https://www.gradio.app) and [LangChain](https://www.langchain.com). The web app source code can be found in `chart/web-app` and gets written to a ConfigMap during the chart build and is then mounted into the UI pod and executed as the entry point for the UI docker image (built from `images/ui-base/Dockerfile`).
 
 - A [stakater/Reloader](https://github.com/stakater/Reloader) instance which monitors the web-app ConfigMap for changes and restarts the frontend when the app code changes (i.e. whenever the Helm values are updated).
+
+## Development
+
+The GitHub repository includes a [tilt](https://tilt.dev) file for easier development. After installing tilt locally, simply run `tilt up` from the repo root to get started with development. This will trigger the following:
+
+- Install the backend API components of the Helm chart on the remote k8s cluster specified by your current k8s context.
+
+- Create a port-forward from the remote cluster to `localhost:8080`
+
+- Create a local `tilt-dev-venv` in the repo root containing the required Python dependencies to run the frontend web app locally.
+
+- Launch the frontend web app locally on `127.0.0.1:7860`, configured to use `localhost:8080` as the backend API
+
+- Watch all components and only reload the minimal set of components needed when a file in the repo changes (e.g. modifying `chart/web-app/app.py` will restart the local web app instance only)

Tiltfile

@@ -0,0 +1,58 @@
+# The HuggingFace model to use for testing
+# hf_model = "ise-uiuc/Magicoder-S-DS-6.7B"
+hf_model = "TheBloke/WizardCoder-Python-34B-V1.0-AWQ"
+
+# Toggles whether UI should be run locally using gradio hot-reloading
+# or should be included in the remote Helm install
+run_ui_locally = True
+
+# Tilt warns is if we try to use tilt against a cluster named 'production'
+# Use this line to allow it for now
+allow_k8s_contexts('production-llm-service-admin@production-llm-service')
+
+# TODO: Include image builds in tilt up
+# docker_build("images/ui-base/")
+
+chart_yaml = helm(
+    "chart/",
+    values="hu-dev-values.yml",
+    # Enable/disable remote UI install depending on if we're running it locally
+    set=[
+        "huggingface.model={}".format(hf_model),
+        "ui.enabled={}".format(not str(run_ui_locally).lower())
+    ],
+)
+k8s_yaml(chart_yaml)
+
+if not run_ui_locally:
+    # Port-forward web app to localhost:8080
+    k8s_resource("chart-ui", port_forwards="8080:7680")
+
+# Port forward backend UI to localhost:8081 for local web app development
+k8s_resource("chart-api", port_forwards="8081:8000")
+
+if run_ui_locally:
+    venv_name = "tilt-dev-venv"
+    requirements = "images/ui-base/requirements.txt"
+
+    # Ensure venv exists and matches requirements.txt
+    local_resource(
+        name="gradio-app-venv",
+        deps=[requirements],
+        cmd=" && ".join([
+            "([[ -d {} ]] || python3 -m venv {})".format(venv_name, venv_name),
+            "source {}/bin/activate".format(venv_name),
+            "pip install -r {}".format(requirements),
+        ])
+    )
+
+    # Run web app locally
+    local_resource(
+        name="gradio-app",
+        deps=["chart/web-app/"],
+        resource_deps=["gradio-app-venv"],
+        serve_cmd=" && ".join([
+            "cd chart/web-app",
+            "python app.py {}".format(hf_model),
+        ])
+    )

chart/Chart.yaml

@@ -31,4 +31,5 @@ annotations:
 dependencies:
   - name: reloader
     version: 1.0.63
-    repository: https://stakater.github.io/stakater-charts
+    repository: https://stakater.github.io/stakater-charts
+    condition: ui.enabled

chart/templates/ui/app-config-map.yml

@@ -1,3 +1,4 @@
+{{- if .Values.ui.enabled -}}
 apiVersion: v1
 kind: ConfigMap
 metadata:
@@ -8,3 +9,4 @@ data:
 {{ (.Files.Glob "web-app/*").AsConfig | nindent 2 }}
   settings.yml: |
     {{- .Values.ui.appSettings | toYaml | nindent 4 }}
+{{- end -}}

chart/templates/ui/deployment.yml

@@ -1,3 +1,4 @@
+{{- if .Values.ui.enabled -}}
 apiVersion: apps/v1
 kind: Deployment
 metadata:
@@ -10,7 +11,7 @@ metadata:
 spec:
   replicas: 1
   selector:
-    matchLabels: 
+    matchLabels:
       {{- include "azimuth-llm.ui-selectorLabels" . | nindent 6 }}
   strategy:
     {{- .Values.ui.updateStrategy | toYaml | nindent 4 }}
@@ -29,7 +30,7 @@ spec:
         volumeMounts:
         - name: app
           mountPath: /etc/web-app
-        command: 
+        command:
         - python
         args:
         - {{ .Values.ui.entrypoint }}
@@ -44,4 +45,5 @@ spec:
       volumes:
         - name: app
           configMap:
-            name: {{ .Release.Name }}-web-app
+            name: {{ .Release.Name }}-web-app
+{{- end -}}

chart/templates/ui/service.yml

@@ -1,3 +1,4 @@
+{{- if .Values.ui.enabled -}}
 apiVersion: v1
 kind: Service
 metadata:
@@ -12,4 +13,5 @@ spec:
     targetPort: ui
   type: {{ .Values.ui.service.type }}
   selector:
-    {{- include "azimuth-llm.ui-selectorLabels" . | nindent 4 }}
+    {{- include "azimuth-llm.ui-selectorLabels" . | nindent 4 }}
+{{- end -}}

chart/templates/ui/ui-zenith-client.yml

@@ -1,3 +1,4 @@
+{{- if .Values.ui.enabled -}}
 {{- if .Values.ui.service.zenith.enabled -}}
 apiVersion: zenith.stackhpc.com/v1alpha1
 kind: Client
@@ -11,4 +12,5 @@ spec:
     serviceName: {{ .Values.ui.service.name }}
   auth:
     skip: {{ .Values.ui.service.zenith.skipAuth }}
-{{- end -}}
+{{- end -}}
+{{- end -}}

chart/templates/ui/ui-zenith-reservation.yml

@@ -1,3 +1,4 @@
+{{- if .Values.ui.enabled -}}
 {{- if .Values.ui.service.zenith.enabled -}}
 apiVersion: zenith.stackhpc.com/v1alpha1
 kind: Reservation
@@ -13,4 +14,5 @@ metadata:
     {{- end }}
 spec:
   credentialSecretName: {{ .Release.Name }}-ui-zenith-credential
+{{- end -}}
 {{- end -}}

chart/values.yaml

@@ -64,6 +64,8 @@ api:
 
 # Configuration for the frontend web interface
 ui:
+  # Toggles installation of the gradio web UI
+  enabled: true
   # The file from the UI config map to execute as the entrypoint to the frontend app
   entrypoint: app.py
   # The values to be written to settings.yml for parsing as frontend app setting