fix: Allow for frontend url to be explicitly configured (#101)

Fixes: HDX-2201

* Removes appUrl from config
* Removes logic that would render frontendurl conditionally
* Updated tests
* Update readme

Author: teeohhem

.changeset/polite-bats-exercise.md

@@ -0,0 +1,5 @@
+---
+"helm-charts": minor
+---
+
+fix: Allow for frontend url to be explicitly configured

.github/workflows/chart-test.yml

@@ -72,7 +72,7 @@ jobs:
         cat > test-values.yaml << EOF
         hyperdx:
           apiKey: "test-api-key-for-ci"
-          appUrl: "http://localhost:3000"
+          frontendUrl: "http://localhost:3000"
           replicas: 1
 
         clickhouse:

README.md

@@ -252,15 +252,15 @@ hyperdx:
     host: "hyperdx.yourdomain.com"  # Set this to your desired domain
 ```
 
-#### Configuring `ingress.host` and `hyperdx.appUrl`
+#### Configuring `ingress.host` and `hyperdx.frontendUrl`
 
 - **`hyperdx.ingress.host`**: Set to the domain you want to use for accessing HyperDX (e.g., `hyperdx.yourdomain.com`).
-- **`hyperdx.appUrl`**: Should match the ingress host and include the protocol (e.g., `https://hyperdx.yourdomain.com`).
+- **`hyperdx.frontendUrl`**: Should match the ingress host and include the protocol (e.g., `https://hyperdx.yourdomain.com`).
 
 **Example:**
 ```yaml
 hyperdx:
-  appUrl: "https://hyperdx.yourdomain.com"
+  frontendUrl: "https://hyperdx.yourdomain.com"
   ingress:
     enabled: true
     host: "hyperdx.yourdomain.com"
@@ -323,7 +323,7 @@ spec:
 
 - **Path and Rewrite Configuration:**
   - For Next.js and other SPAs, always use a regex path and rewrite annotation as shown above. Do not use just `path: /` without a rewrite, as this will break static asset serving.
-- **Mismatched `appUrl` and `ingress.host`:**
+- **Mismatched `frontendUrl` and `ingress.host`:**
   - If these do not match, you may experience issues with cookies, redirects, and asset loading.
 - **TLS Misconfiguration:**
   - Ensure your TLS secret is valid and referenced correctly in the ingress.
@@ -448,7 +448,7 @@ Use the fully qualified domain name (FQDN) for the OpAMP server URL:
 
 ```bash
 helm install my-hyperdx hyperdx/hdx-oss-v2 \
-  --set hyperdx.appUrl="http://your-external-ip-or-domain.com" \
+  --set hyperdx.frontendUrl="http://your-external-ip-or-domain.com" \
   --set otel.opampServerUrl="http://my-hyperdx-hdx-oss-v2-app.default.svc.cluster.local:4320"
 ```
 
@@ -457,7 +457,7 @@ helm install my-hyperdx hyperdx/hdx-oss-v2 \
 ```yaml
 # values-gke.yaml
 hyperdx:
-  appUrl: "http://34.123.61.99"  # Use your LoadBalancer external IP
+  frontendUrl: "http://34.123.61.99"  # Use your LoadBalancer external IP
 
 otel:
   opampServerUrl: "http://my-hyperdx-hdx-oss-v2-app.default.svc.cluster.local:4320"
@@ -477,7 +477,7 @@ For EKS deployments, consider these common configurations:
 ```yaml
 # values-eks.yaml
 hyperdx:
-  appUrl: "http://your-alb-domain.com"
+  frontendUrl: "http://your-alb-domain.com"
 
 # EKS typically uses these pod CIDRs
 clickhouse:
@@ -502,7 +502,7 @@ For AKS deployments:
 ```yaml
 # values-aks.yaml
 hyperdx:
-  appUrl: "http://your-azure-lb.com"
+  frontendUrl: "http://your-azure-lb.com"
 
 # AKS pod networking
 clickhouse:
@@ -514,7 +514,7 @@ clickhouse:
 
 ### Production Cloud Deployment Checklist
 
-- [ ] Configure proper `appUrl` with your external domain/IP
+- [ ] Configure proper `frontendUrl` with your external domain/IP
 - [ ] Set up ingress with TLS for HTTPS access
 - [ ] Override `otel.opampServerUrl` with FQDN if experiencing connection issues
 - [ ] Adjust `clickhouse.config.clusterCidrs` for your pod network CIDR

charts/hdx-oss-v2/templates/configmaps/app-configmap.yaml

@@ -7,14 +7,9 @@ metadata:
 data:
   APP_PORT: {{ .Values.hyperdx.appPort | quote }}
   API_PORT: {{ .Values.hyperdx.apiPort | quote }}
-  {{- if .Values.hyperdx.ingress.enabled }}
-  FRONTEND_URL: "{{ if .Values.hyperdx.ingress.tls.enabled }}https{{ else }}http{{ end }}://{{ .Values.hyperdx.ingress.host }}"
-  {{- else }}
-  FRONTEND_URL: "{{ .Values.hyperdx.appUrl }}:{{ .Values.hyperdx.appPort }}"
-  {{- end }}
+  FRONTEND_URL: "{{ tpl .Values.hyperdx.frontendUrl . }}"
   HYPERDX_API_PORT: "{{ .Values.hyperdx.apiPort }}"
   HYPERDX_APP_PORT: "{{ .Values.hyperdx.appPort }}"
-  HYPERDX_APP_URL: "{{ .Values.hyperdx.appUrl }}"
   HYPERDX_LOG_LEVEL: "{{ .Values.hyperdx.logLevel }}"
   MINER_API_URL: "http://{{ include "hdx-oss.fullname" . }}-miner:5123"
   MONGO_URI: "{{ tpl .Values.hyperdx.mongoUri . }}"

charts/hdx-oss-v2/tests/configmap_test.yaml

@@ -7,7 +7,7 @@ tests:
       hyperdx:
         apiPort: 8000
         appPort: 3000
-        appUrl: http://localhost
+        frontendUrl: http://localhost:3000
         logLevel: info
         usageStatsEnabled: true
       mongodb:
@@ -41,48 +41,3 @@ tests:
       - matchRegex:
           path: data.MONGO_URI
           pattern: mongodb://.*-mongodb:27017/hyperdx
-
-  - it: should use ingress URL for FRONTEND_URL when ingress is enabled
-    set:
-      hyperdx:
-        apiPort: 8000
-        appPort: 3000
-        appUrl: http://localhost
-        ingress:
-          enabled: true
-          host: hyperdx.example.com
-          tls:
-            enabled: false
-    asserts:
-      - equal:
-          path: data.FRONTEND_URL
-          value: "http://hyperdx.example.com"
-
-  - it: should use ingress HTTPS URL for FRONTEND_URL when TLS is enabled
-    set:
-      hyperdx:
-        apiPort: 8000
-        appPort: 3000
-        appUrl: http://localhost
-        ingress:
-          enabled: true
-          host: hyperdx.example.com
-          tls:
-            enabled: true
-    asserts:
-      - equal:
-          path: data.FRONTEND_URL
-          value: "https://hyperdx.example.com"
-
-  - it: should fallback to appUrl:port when ingress is disabled
-    set:
-      hyperdx:
-        apiPort: 8000
-        appPort: 4000
-        appUrl: http://custom-host
-        ingress:
-          enabled: false
-    asserts:
-      - equal:
-          path: data.FRONTEND_URL
-          value: "http://custom-host:4000"

charts/hdx-oss-v2/values.yaml

@@ -43,7 +43,9 @@ hyperdx:
   apiPort: 8000
   appPort: 3000
   opampPort: 4320
-  appUrl: "http://localhost"
+  # The URL that will be use to access the frontend. Defaults to the http://localhost:appPort.
+  # If you have an ingress enabled, you should set this to the ingress host with the protocol. E.g. https://hdx-my-domain.com
+  frontendUrl: http://localhost:{{ .Values.hyperdx.appPort }}
   logLevel: "info"
   usageStatsEnabled: true
   # Endpoint to send hyperdx logs/traces/metrics to.Defaults to the chart's otel collector endpoint.
@@ -182,6 +184,7 @@ hyperdx:
     enabled: false
     ingressClassName: nginx
     annotations: {}
+    # The host to use for the ingress. Defaults to localhost. Be sure to update hyperdx.frontendUrl with this host value + protocol
     host: "localhost"  # Production domain
     path: "/(.*)"
     pathType: "ImplementationSpecific"