Refactor Helm Chart to Service-Specific Templates

.github/workflows/helm-tests.yml

@@ -196,21 +196,29 @@ jobs:
           kubectl get ingress --all-namespaces -o jsonpath='{range .items[0]}kubectl describe ingress {.metadata.name} -n {.metadata.namespace}{end}' | sh
           kubectl get middleware.traefik.io --all-namespaces -o custom-columns='NAMESPACE:.metadata.namespace,NAME:.metadata.name' --no-headers | while read -r namespace name; do kubectl describe middleware.traefik.io "$name" -n "$namespace"; done
 
-          PUBLICIP='http://'$(kubectl -n kube-system get svc traefik -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
-          export VECTOR_ENDPOINT=$PUBLICIP/vector$RELEASE_NAME
-          export STAC_ENDPOINT=$PUBLICIP/stac$RELEASE_NAME
-          export RASTER_ENDPOINT=$PUBLICIP/raster$RELEASE_NAME
+          # Get the IP address of the Traefik service
+          PUBLICIP_VALUE=$(kubectl -n kube-system get svc traefik -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
+          PUBLICIP=http://eoapi.local
+          export VECTOR_ENDPOINT=$PUBLICIP/vector
+          export STAC_ENDPOINT=$PUBLICIP/stac
+          export RASTER_ENDPOINT=$PUBLICIP/raster
+
+          # Add entry to /etc/hosts for eoapi.local
+          echo "Adding eoapi.local to /etc/hosts with IP: $PUBLICIP_VALUE"
+          echo "$PUBLICIP_VALUE eoapi.local" | sudo tee -a /etc/hosts
 
           echo '#################################'
           echo $VECTOR_ENDPOINT
           echo $STAC_ENDPOINT
           echo $RASTER_ENDPOINT
           echo '#################################'
 
-          pytest .github/workflows/tests/test_vector.py || kubectl logs svc/vector
-          pytest .github/workflows/tests/test_stac.py || kubectl logs svc/stac
+          # Run tests with proper failure propagation
+          set -e  # Make sure any command failure causes the script to exit with error
+          pytest .github/workflows/tests/test_vector.py || { kubectl logs svc/vector; exit 1; }
+          pytest .github/workflows/tests/test_stac.py || { kubectl logs svc/stac; exit 1; }
           # TODO: fix raster tests
-          #pytest .github/workflows/tests/test_raster.py || kubectl logs svc/raster
+          #pytest .github/workflows/tests/test_raster.py || { kubectl logs svc/raster; exit 1; }
 
       - name: error if tests failed
         if: steps.testrunner.outcome == 'failure'

docs/stac-auth-proxy.md

@@ -0,0 +1,127 @@
+# STAC Auth Proxy Integration with EOAPI-K8S
+
+## Solution Overview
+
+We have implemented support for STAC Auth Proxy integration with EOAPI-K8S through service-specific ingress control. This feature allows the STAC service to be accessible only internally while other services remain externally available.
+
+## Implementation Details
+
+### 1. Service-Specific Ingress Control
+
+Each service can now independently control its ingress settings via the values.yaml configuration:
+
+```yaml
+stac:
+  enabled: true
+  ingress:
+    enabled: false  # Disable external ingress for STAC only
+
+# Other services remain externally accessible
+raster:
+  enabled: true
+  ingress:
+    enabled: true
+```
+
+### 2. Template Changes
+
+The ingress template now checks service-specific settings:
+
+```yaml
+{{- if and .Values.stac.enabled (or (not (hasKey .Values.stac "ingress")) .Values.stac.ingress.enabled) }}
+- pathType: {{ .Values.ingress.pathType }}
+  path: /stac{{ .Values.ingress.pathSuffix }}
+  backend:
+    service:
+      name: stac
+      port:
+        number: {{ .Values.service.port }}
+{{- end }}
+```
+
+This ensures:
+- Service paths are only included if the service and its ingress are enabled
+- Backward compatibility is maintained (ingress enabled by default)
+- Clean separation of service configurations
+
+## Deployment Guide
+
+### 1. Configure EOAPI-K8S
+
+```yaml
+# values.yaml for eoapi-k8s
+stac:
+  enabled: true
+  ingress:
+    enabled: false  # No external ingress for STAC
+
+# Other services remain externally accessible
+raster:
+  enabled: true
+vector:
+  enabled: true
+multidim:
+  enabled: true
+```
+
+### 2. Deploy STAC Auth Proxy
+
+Deploy the stac-auth-proxy Helm chart in the same namespace:
+
+```yaml
+# values.yaml for stac-auth-proxy
+backend:
+  service: stac  # Internal K8s service name
+  port: 8080     # Service port
+
+auth:
+  # Configure authentication settings
+  provider: oauth2
+  # ... other auth settings
+```
+
+### 3. Network Flow
+
+```mermaid
+graph LR
+    A[External Request] --> B[STAC Auth Proxy]
+    B -->|Authentication| C[Internal STAC Service]
+    D[External Request] -->|Direct Access| E[Raster/Vector/Other Services]
+```
+
+## Testing
+
+Verify the configuration:
+
+```bash
+# Check that STAC paths are excluded
+helm template eoapi --set stac.ingress.enabled=false,stac.enabled=true -f values.yaml
+
+# Verify other services remain accessible
+kubectl get ingress
+kubectl get services
+```
+
+Expected behavior:
+- STAC service accessible only within the cluster
+- Other services (raster, vector, etc.) accessible via their ingress paths
+- Auth proxy successfully routing authenticated requests to STAC
+
+## Troubleshooting
+
+1. **STAC Service Not Accessible Internally**
+   - Verify service is running: `kubectl get services`
+   - Check service port matches auth proxy configuration
+   - Verify network policies allow proxy-to-STAC communication
+
+2. **Other Services Affected**
+   - Confirm ingress configuration for other services
+   - Check ingress controller logs
+   - Verify service-specific settings in values.yaml
+
+## Additional Notes
+
+- The solution leverages Kubernetes service discovery for internal communication
+- No changes required to the STAC service itself
+- Zero downtime deployment possible
+- Existing deployments without auth proxy remain compatible

docs/unified-ingress.md

@@ -0,0 +1,107 @@
+# Unified Ingress Configuration
+
+This document describes the unified ingress approach implemented in the eoAPI Helm chart.
+
+## Overview
+
+eoAPI now uses a consolidated, controller-agnostic ingress configuration. This approach:
+
+- Eliminates code duplication between different ingress controller implementations
+- Provides consistent behavior across controllers
+- Simplifies testing and maintainability
+- Removes artificial restrictions on using certain ingress controllers in specific environments
+- Makes it easier to add support for additional ingress controllers in the future
+
+## Configuration
+
+The ingress configuration has been streamlined and generalized in the `values.yaml` file:
+
+```yaml
+ingress:
+  # Unified ingress configuration for both nginx and traefik
+  enabled: true
+  # ingressClassName: "nginx" or "traefik"
+  className: "nginx"
+  # Path configuration
+  pathType: "Prefix"  # Can be "Prefix" or "ImplementationSpecific" based on controller
+  pathSuffix: ""      # Add a suffix to service paths (e.g. "(/|$)(.*)" for nginx regex)
+  rootPath: ""        # Root path for doc server
+  # Host configuration
+  host: ""
+  # Custom annotations to add to the ingress
+  annotations: {}
+  # TLS configuration
+  tls:
+    enabled: false
+    secretName: eoapi-tls
+    certManager: false
+    certManagerIssuer: letsencrypt-prod
+    certManagerEmail: ""
+```
+
+## Controller-Specific Configurations
+
+### NGINX Ingress Controller
+
+For NGINX, use the following configuration:
+
+```yaml
+ingress:
+  enabled: true
+  className: "nginx"
+  pathType: "Prefix"
+  annotations:
+    nginx.ingress.kubernetes.io/use-regex: "true"
+    nginx.ingress.kubernetes.io/enable-cors: "true"
+    nginx.ingress.kubernetes.io/enable-access-log: "true"
+```
+
+### Traefik Ingress Controller
+
+When using Traefik, the system automatically includes the Traefik middleware to strip prefixes (e.g., `/stac`, `/raster`) from requests before forwarding them to services. This is handled by the `traefik-middleware.yaml` template.
+
+For basic Traefik configuration:
+
+```yaml
+ingress:
+  enabled: true
+  className: "traefik"
+  pathType: "Prefix"
+  # When using TLS, setting host is required to avoid "No domain found" warnings
+  host: "example.domain.com"  # Required to work properly with TLS
+  annotations:
+    traefik.ingress.kubernetes.io/router.entrypoints: web
+```
+
+For Traefik with TLS:
+
+```yaml
+ingress:
+  enabled: true
+  className: "traefik"
+  pathType: "Prefix"
+  # Host is required when using TLS with Traefik
+  host: "example.domain.com"
+  annotations:
+    traefik.ingress.kubernetes.io/router.entrypoints: websecure
+  tls:
+    enabled: true
+    secretName: eoapi-tls
+```
+
+## Migration
+
+If you're migrating from a previous version, follow these guidelines:
+
+1. Update your values to use the new unified configuration
+2. Ensure your ingress controller-specific annotations are set correctly
+3. Set the appropriate `pathType` for your controller
+4. Test the configuration before deploying to production
+
+## Note for Traefik Users
+
+Traefik is now fully supported in all environments, including production. The previous restriction limiting Traefik to testing environments has been removed.
+
+## Document Server
+
+The document server implementation has also been unified. It now works with both NGINX and Traefik controllers using the same configuration.

helm-chart/eoapi/.helmignore

@@ -22,3 +22,5 @@
 *.tmproj
 .vscode/
 tests/
+# Ignore all README.md in all subdirectories 
+README.md

helm-chart/eoapi/templates/_helpers.tpl

@@ -397,14 +397,3 @@ validate:
 {{- end -}}
 
 {{- end -}}
-
-{{/*
-validate:
-that you can only use traefik as ingress when `testing=true`
-*/}}
-{{- define "eoapi.validateTraefik" -}}
-{{- if and (not .Values.testing) (eq .Values.ingress.className "traefik") $ -}}
-  {{- fail "you cannot use traefik yet outside of testing" -}}
-{{- end -}}
-
-{{- end -}}

helm-chart/eoapi/templates/pgstacbootstrap/job.yaml

@@ -29,7 +29,7 @@ metadata:
   annotations:
     helm.sh/hook: "post-install,post-upgrade"
     helm.sh/hook-weight: "-5"
-    helm.sh/hook-delete-policy: "before-hook-creation,hook-succeeded"
+    helm.sh/hook-delete-policy: "before-hook-creation"
 spec:
   template:
     metadata:
@@ -97,7 +97,7 @@ metadata:
   annotations:
     helm.sh/hook: "post-install,post-upgrade"
     helm.sh/hook-weight: "-4"
-    helm.sh/hook-delete-policy: "before-hook-creation,hook-succeeded"
+    helm.sh/hook-delete-policy: "before-hook-creation"
 spec:
   template:
     metadata: