Retire installation plugin

.github/workflows/ci-github-cms.yaml → .github/workflows/ci-full.yaml

@@ -1,4 +1,4 @@
-name: ci [CMS]
+name: ci [full]
 
 on:
   push:
@@ -55,7 +55,7 @@ jobs:
           helm repo add opentelemetry https://open-telemetry.github.io/opentelemetry-helm-charts
           helm dependency build ./helm/supersonic
           helm upgrade --install supersonic ./helm/supersonic \
-            --values values/values-cms-ci.yaml -n cms
+            --values values/values-minimal-full.yaml -n cms
 
       - name: CVMFS Mount ready
         run: |
@@ -84,8 +84,8 @@ jobs:
 
       - name: Autoscaler ready
         run: |
-          kubectl wait --for condition=AbleToScale hpa -l app.kubernetes.io/component=keda --timeout 120s -n cms
-          kubectl wait --for condition=Ready so -l app.kubernetes.io/component=keda --timeout 120s -n cms
+          kubectl wait --for condition=AbleToScale hpa -l app.kubernetes.io/component=keda --timeout 180s -n cms
+          kubectl wait --for condition=Ready so -l app.kubernetes.io/component=keda --timeout 180s -n cms
 
       - name: Triton server ready
         run: |

.github/workflows/ci-github-installer-plugin.yaml → .github/workflows/ci-installation.yaml

@@ -1,4 +1,4 @@
-name: ci [installer plugin]
+name: ci [installation]
 
 on:
   push:
@@ -9,7 +9,7 @@ on:
       - "main"
 
 jobs:
-  test-installer-plugin:
+  test-installation:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -25,9 +25,9 @@ jobs:
         with:
           version: v3.12.0
 
-      - name: Create CMS namespace
+      - name: Create test namespace
         run: |
-          kubectl create namespace cms
+          kubectl create namespace test-ns
 
       - name: Install Prometheus Operator CRDs
         run: |
@@ -36,17 +36,32 @@ jobs:
           kubectl create namespace monitoring
           helm install prometheus-operator prometheus-community/kube-prometheus-stack --namespace monitoring --set prometheusOperator.createCustomResource=false --set defaultRules.create=false --set alertmanager.enabled=false --set prometheus.enabled=false --set grafana.enabled=false
 
-      - name: Install KEDA Autoscaler
+      - name: Install KEDA Autoscaler CRDs
         run: |
           helm repo add kedacore https://kedacore.github.io/charts
           helm repo update
           kubectl create namespace keda
           helm install keda kedacore/keda --namespace keda  
 
-      - name: Install SuperSONIC from remote repo via plugin
+      - name: Test installation of SuperSONIC from remote repo via plugin
         run: |
-          helm plugin install .
-          helm install-supersonic supersonic --local --values values/values-cms-ci.yaml -n cms
+          helm repo add fastml https://fastmachinelearning.org/SuperSONIC/
+          helm repo update
+          helm install supersonic fastml/supersonic -n test-ns -f values/values-minimal.yaml
+          helm uninstall supersonic -n test-ns
+
+      - name: Test installation of SuperSONIC from GitHub
+        run: |
+          # Add dependencies
+          helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
+          helm repo add grafana https://grafana.github.io/helm-charts
+          helm repo add opentelemetry https://open-telemetry.github.io/opentelemetry-helm-charts
+          helm repo update
+
+          # Install SuperSONIC
+          helm dependency build helm/supersonic
+          helm install supersonic helm/supersonic -n test-ns -f values/values-minimal.yaml
+          helm uninstall supersonic -n test-ns
 
       - name: Cleanup
         run: kind delete cluster --name gh-k8s-cluster 

README.md

@@ -31,36 +31,27 @@ The main components of SuperSONIC are:
 
 ## Installation
 
-The installation is done via a custom Helm plugin which takes care of
-internal connectivity of the chart components. Standard Helm installation
-is also supported, but requires a lot more manual configuration.
+### Install from Helm repository
 
 ```
-helm plugin install https://github.com/fastmachinelearning/SuperSONIC/
-helm install-supersonic <release-name> -n <namespace> -f <your-values.yaml>
-```
-
-Installer plugin usage:
-```
-Usage:
-  helm install-supersonic [RELEASE_NAME] [flags]
-
-Flags:
-  -h, --help              Show this help message
-  -f, --values            Specify values file for custom configuration
-  -n, --namespace         Specify Kubernetes namespace for deployment
-  --version               Specify chart version (default: latest version)
-                          Note: Ignored if --local flag is set
-  --local                 Install from local chart path instead of remote repository
-  --path                  Local chart path (default: ./helm/supersonic)
-                          Only used when --local flag is set
-Additional flags will be passed directly to the 'helm install' command
+helm repo add fastml https://fastmachinelearning.org/SuperSONIC
+helm repo update
+helm install <release-name> fastml/supersonic -n <namespace> -f <your-values.yaml>
 ```
 
 To construct the `values.yaml` file for your application, follow [Configuration guide](http://fastmachinelearning.org/SuperSONIC/configuration-guide.html "Configuration guide").
 
 The full list of configuration parameters is available in the [Configuration reference](http://fastmachinelearning.org/SuperSONIC/configuration-reference.html "Configuration reference").
 
+### Install from GitHub 
+
+```
+git clone https://github.com/fastmachinelearning/SuperSONIC.git
+cd SuperSONIC
+git checkout <branch-or-commit>
+helm dependency build helm/supersonic
+helm install <release-name> helm/supersonic -n <namespace> -f <your-values.yaml>
+```
 
 ## Server diagram
 

docs/.values-table.md

@@ -43,6 +43,7 @@
 | envoy.auth.audiences | list | `[]` |  |
 | envoy.auth.url | string | `""` |  |
 | envoy.auth.port | int | `443` |  |
+| envoy.tracing_sampling_rate | float | `0.01` |  |
 | autoscaler.enabled | bool | `false` | Enable autoscaling (requires Prometheus to also be enabled). Autoscaling will be based on the metric is taken from parameter ``prometheus.serverLoadMetric``, new Triton servers will spawn if the metric exceedds the threshold set by ``prometheus.serverLoadThreshold``. |
 | autoscaler.minReplicaCount | int | `1` | Minimum and maximum number of Triton servers. Warning: if min=0 and desired Prometheus metric is empty, the first server will never start |
 | autoscaler.maxReplicaCount | int | `2` |  |
@@ -125,7 +126,6 @@
 | tempo.tempo.receivers.otlp.protocols.http.endpoint | string | `"0.0.0.0:4318"` |  |
 | tempo.tempo.livenessProbe.initialDelaySeconds | int | `0` |  |
 | tempo.tempo.readinessProbe.initialDelaySeconds | int | `0` |  |
-| tracing_sampling_rate | float | `0.01` |  |
 | opentelemetry-collector.enabled | bool | `false` |  |
 | opentelemetry-collector.image.repository | string | `"otel/opentelemetry-collector-contrib"` |  |
 | opentelemetry-collector.image.tag | string | `"0.120.0"` |  |

docs/advanced-monitoring.rst

@@ -43,8 +43,7 @@ Displaying Tracing Data in Grafana
 
 If Grafana is enabled in your ``values.yaml``, you can display the tracing data
 in the Grafana dashboard. In order to achieve this, Grafana needs to have a
-Tempo datasource configured. This is done automatically when you install
-SuperSONIC via the ``install-supersonic`` plugin.
+Tempo datasource configured. 
 
 If OpenTelemetry Collector and Tempo are enabled, the default Grafana dashboard
 will include an interactive server map, where you can study tracing data in detail

docs/getting-started.rst

@@ -19,41 +19,18 @@ Installation
       - `Configuration reference <configuration-reference>`_
       - `Example values.yaml files <https://github.com/fastmachinelearning/SuperSONIC/tree/main/values>`_
 
-   2. Install Helm plugin to handle SuperSONIC installation
+   2. Install Helm repository
 
       .. code:: shell
 
-         helm plugin install https://github.com/fastmachinelearning/SuperSONIC/
-
-
-      The Helm plugin is needed to ensure internal connectivity of the SuperSONIC
-      components. Standard Helm installation without a plugin is also supported,
-      but requires a lot more manual configuration.
+         helm repo add fastml https://fastmachinelearning.org/SuperSONIC/
+         helm repo update
 
    3. Modify the following command to install the chart at your cluster:
 
       .. code:: shell
 
-         helm install-supersonic <release-name> -n <namespace> -f <your-values.yaml>
-
-      Installer plugin usage:
-
-      .. code:: shell
-
-         Usage:
-           helm install-supersonic [RELEASE_NAME] [flags]
-
-         Flags:
-         -h, --help              Show this help message
-         -f, --values            Specify values file for custom configuration
-         -n, --namespace         Specify Kubernetes namespace for deployment
-         --version               Specify chart version (default: latest version)
-                                 Note: Ignored if --local flag is set
-         --local                 Install from local chart path instead of remote repository
-         --path                  Local chart path (default: ./helm/supersonic)
-                                 Only used when --local flag is set
-         Additional flags will be passed directly to the 'helm install' command
-
+         helm install <release-name> fastml/supersonic -n <namespace> -f <your-values.yaml>
 
       Use a unique meaningful lowercase value as <release-name>, for example
       ``supersonic-cms-run3``.

helm/supersonic/README.md

@@ -31,36 +31,27 @@ The main components of SuperSONIC are:
 
 ## Installation
 
-The installation is done via a custom Helm plugin which takes care of
-internal connectivity of the chart components. Standard Helm installation
-is also supported, but requires a lot more manual configuration.
+### Install from Helm repository
 
 ```
-helm plugin install https://github.com/fastmachinelearning/SuperSONIC/
-helm install-supersonic <release-name> -n <namespace> -f <your-values.yaml>
-```
-
-Installer plugin usage:
-```
-Usage:
-  helm install-supersonic [RELEASE_NAME] [flags]
-
-Flags:
-  -h, --help              Show this help message
-  -f, --values            Specify values file for custom configuration
-  -n, --namespace         Specify Kubernetes namespace for deployment
-  --version               Specify chart version (default: latest version)
-                          Note: Ignored if --local flag is set
-  --local                 Install from local chart path instead of remote repository
-  --path                  Local chart path (default: ./helm/supersonic)
-                          Only used when --local flag is set
-Additional flags will be passed directly to the 'helm install' command
+helm repo add fastml https://fastmachinelearning.org/SuperSONIC
+helm repo update
+helm install <release-name> fastml/supersonic -n <namespace> -f <your-values.yaml>
 ```
 
 To construct the `values.yaml` file for your application, follow [Configuration guide](http://fastmachinelearning.org/SuperSONIC/configuration-guide.html "Configuration guide").
 
 The full list of configuration parameters is available in the [Configuration reference](http://fastmachinelearning.org/SuperSONIC/configuration-reference.html "Configuration reference").
 
+### Install from GitHub 
+
+```
+git clone https://github.com/fastmachinelearning/SuperSONIC.git
+cd SuperSONIC
+git checkout <branch-or-commit>
+helm dependency build helm/supersonic
+helm install <release-name> helm/supersonic -n <namespace> -f <your-values.yaml>
+```
 
 ## Server diagram
 

helm/supersonic/templates/NOTES.txt

@@ -2,7 +2,6 @@
 {{- /* Run validation checks */ -}}
 {{- include "supersonic.validateGrafanaAddressConsistency" . -}}
 {{- include "supersonic.validateGrafanaValues" . -}}
-{{- include "supersonic.validatePrometheus" . -}}
 {{- include "supersonic.validatePrometheusAddressConsistency" . -}}
 {{- include "supersonic.validatePrometheusValues" . -}}
 
@@ -38,7 +37,7 @@ Scaling threshold: {{ include "supersonic.defaultThreshold" . }}
 |
 | Prometheus UI:           {{ include "supersonic.prometheusDisplayUrl" . }}
 {{- end }}
-{{- if or .Values.grafana.enabled (include "supersonic.grafanaExists" .) }}
+{{- if .Values.grafana.enabled }}
 |
 | Grafana dashboard:       {{ include "supersonic.grafanaDisplayUrl" . }}
 {{- end }}

helm/supersonic/templates/_helpers/_grafana.tpl

@@ -53,26 +53,6 @@ Get full Grafana URL
 {{- include "supersonic.common.getServiceUrl" (dict "scheme" (include "supersonic.grafanaScheme" .) "host" (include "supersonic.grafanaHost" .) "port" (include "supersonic.grafanaPort" .)) -}}
 {{- end -}}
 
-{{/*
-Check if Grafana exists in the namespace
-*/}}
-{{- define "supersonic.grafanaExists" -}}
-{{- include "supersonic.common.serviceExists" (dict "serviceName" "grafana" "root" .) -}}
-{{- end -}}
-
-{{/*
-Validate that there is no existing Grafana instance when enabling a new one
-*/}}
-{{- define "supersonic.validateGrafana" -}}
-{{- if .Values.grafana.enabled -}}
-  {{- if include "supersonic.grafanaExists" . -}}
-    {{- $details := fromJson (include "supersonic.common.getExistingServiceDetails" (dict "serviceType" "grafana" "root" .)) -}}
-    {{- $url := include "supersonic.common.getServiceDisplayUrl" (dict "scheme" $details.scheme "host" $details.host) -}}
-    {{- fail (printf "Error: Found existing Grafana instance in the namespace:\n- Namespace: %s\n- URL: %s\n\nTo proceed, either:\n1. Set grafana.enabled=false in values.yaml to use the existing Grafana instance, OR\n2. Uninstall the existing Grafana instance" .Release.Namespace $url) -}}
-  {{- end -}}
-{{- end -}}
-{{- end -}}
-
 {{/*
 Validate Grafana address consistency
 */}}

helm/supersonic/templates/_helpers/_prometheus.tpl

@@ -62,13 +62,6 @@ Check if Prometheus exists in the namespace
 {{- include "supersonic.common.serviceExists" (dict "serviceName" "prometheus" "root" .) -}}
 {{- end -}}
 
-{{/*
-Validate that there is no existing Prometheus instance when enabling a new one
-*/}}
-{{- define "supersonic.validatePrometheus" -}}
-{{- include "supersonic.common.validateNoExistingService" (dict "serviceType" "prometheus" "values" .Values "root" .) -}}
-{{- end -}}
-
 {{/*
 Validate RBAC permissions for Prometheus
 */}}

helm/supersonic/templates/envoy/configmaps.yaml

@@ -36,7 +36,7 @@ static_resources:
                 {{- if (index .root.Values "opentelemetry-collector" "enabled") }}
                 tracing:
                   random_sampling:
-                    value: {{ mulf .root.Values.tracing_sampling_rate 100 }}
+                    value: {{ mulf .envoy.tracing_sampling_rate 100 }}
                   provider:
                     name: envoy.tracers.opentelemetry
                     typed_config:

helm/supersonic/templates/monitoring/default-dashboard.yaml

@@ -1,4 +1,4 @@
-{{- if and .Values.grafana.enabled (ne (include "supersonic.grafanaExists" .) "true") }}
+{{- if .Values.grafana.enabled -}}
 apiVersion: v1
 kind: ConfigMap
 metadata:

helm/supersonic/values.schema.json

@@ -419,6 +419,9 @@
             "port",
             "url"
           ]
+        },
+        "tracing_sampling_rate": {
+          "type": "number"
         }
       },
       "required": [
@@ -432,7 +435,8 @@
         "rate_limiter",
         "replicas",
         "resources",
-        "service"
+        "service",
+        "tracing_sampling_rate"
       ]
     },
     "autoscaler": {
@@ -1360,9 +1364,6 @@
         "tempo"
       ]
     },
-    "tracing_sampling_rate": {
-      "type": "number"
-    },
     "opentelemetry-collector": {
       "type": "object",
       "properties": {
@@ -1948,7 +1949,6 @@
     "serverLoadThreshold",
     "tempo",
     "tolerations",
-    "tracing_sampling_rate",
     "triton"
   ]
 }