Merge branch 'main' of github.com:fetch-rewards/streamlit-operator

Author: samcorzineatfetch

README.md

@@ -6,50 +6,45 @@ With a minimal amount of config for each app, it handles deployment, plus ingres
 It will also install a "Streamlit Hub" app in your cluster, that allows you to view all running apps as well as launch
 new apps from the UI.
 
-## Installation
-
-Details to come
-
 ## Prerequisites
 
 This app has been developed under the assumption that you're running a cluster on EKS in AWS. It will likely work on other clusters
 with minimal changes, but this has not been tested.
 
-## Usage
-
-The operator is built around one StreamlitApp CRD that takes required configuration for each app. 
+## Installation
 
-Currently users must specify four pieces of config:
+The Streamlit Operator comes prepackaged as a Helm chart.  If you've never used helm, please refer to
+Helm's [documentation](https://helm.sh/docs) to get started.
 
-- `name`: The name of the app. This will be used as the name of the deployment, service, ingress, and DNS record.
-- `repo`: The git style URL of the repo containing the app code. This is used to clone the repo into the container. e.g. `[email protected]:MyOrg/my-app.git`
-- `branch`: The branch of the repo to use. Typical usecase will be to track main, but users can also work off development branches.
-- `code_dir`: The directory within the repo that contains the app code. This is used to run `streamlit run` within the container. e.g. `my-app` 
-  - Note that the operator assumes your app's entrypoint is `main.py` within this directory. This will be configurable in the future.
+Once Helm has been set up correctly, add the repo as follows:
 
-## Architecture
+    helm repo add streamlit-operator https://fetch-rewards.github.io/streamlit-operator/
 
-![Architecture](docs/imgs/architecture.png)
+If you had already added this repo earlier, run `helm repo update` to retrieve
+the latest versions of the packages.  You can then run `helm search repo
+<alias>` to see the charts.
 
+To install the chart run:
 
+    helm install streamlit-operator streamlit-operator/streamlit-chart --set baseDnsRecord=<YOUR-COMPANY>.com
 
-## Helm Usage
+To uninstall the chart:
 
-[Helm](https://helm.sh) must be installed to use the charts.  Please refer to
-Helm's [documentation](https://helm.sh/docs) to get started.
+    helm delete streamlit-operator
 
-Once Helm has been set up correctly, add the repo as follows:
 
-    helm repo add <alias> https://<orgname>.github.io/helm-charts
+## Usage
 
-If you had already added this repo earlier, run `helm repo update` to retrieve
-the latest versions of the packages.  You can then run `helm search repo
-<alias>` to see the charts.
+The operator is built around one StreamlitApp CRD that takes required configuration for each app. 
 
-To install the <chart-name> chart:
+Currently users must specify four pieces of config:
 
-    helm install my-<chart-name> <alias>/<chart-name>
+- `name`: The name of the app. This will be used as the name of the deployment, service, ingress, and DNS record.
+- `repo`: The git style URL of the repo containing the app code. This is used to clone the repo into the container. e.g. `[email protected]:MyOrg/my-app.git`
+- `branch`: The branch of the repo to use. Typical usecase will be to track main, but users can also work off development branches.
+- `code_dir`: The directory within the repo that contains the app code. This is used to run `streamlit run` within the container. e.g. `my-app` 
+  - Note that the operator assumes your app's entrypoint is `main.py` within this directory. This will be configurable in the future.
 
-To uninstall the chart:
+## Architecture
 
-    helm delete my-<chart-name>
+![Architecture](docs/imgs/architecture.png)

charts/streamlit-chart/templates/operator-configmap.yaml

@@ -6,6 +6,7 @@ metadata:
 data:
   config.yaml: |
     baseDnsRecord: {{ .Values.baseDnsRecord }}
+    suffix: {{ .Values.suffix }}
     ingressAnnotations:
       {{- range $key, $value := .Values.ingressAnnotations }}
       {{ $key }} : {{ tpl $value $ }}

charts/streamlit-chart/values.yaml

@@ -1,4 +1,5 @@
 #baseDnsRecord: "this-is-a-test"
 #ingressAnnotations:
 #  annotation1: "value1"
-#  annotation2: "value2"
+#  annotation2: "value2"
+suffix: "-streamlit"

src/main.py

@@ -43,7 +43,7 @@ def create_fn(spec, name, namespace, logger, **kwargs):
     kopf.adopt(service_data)
 
     # Template the ingress
-    ingress_data = template_ingress(name, config["baseDnsRecord"], config["ingressAnnotations"])
+    ingress_data = template_ingress(name, config["baseDnsRecord"], config["ingressAnnotations"], config["suffix"])
     kopf.adopt(ingress_data)
 
     api = kubernetes.client.CoreV1Api()

src/templating.py

@@ -106,8 +106,8 @@ def template_service(name):
     return service_dict
 
 
-def template_ingress(name, base_dns_path, ingress_annotations):
-    dns_name = f"{name}-streamlit.{base_dns_path}"
+def template_ingress(name, base_dns_path, ingress_annotations, suffix):
+    dns_name = f"{name}{suffix}.{base_dns_path}"
     ingress_dict = {
         "apiVersion": "networking.k8s.io/v1",
         "kind": "Ingress",