feat: add gubbins-charts Helm chart for gubbins extension (#691)

* feat: add gubbins-charts Helm chart for gubbins extension

Add umbrella Helm chart for the gubbins DiracX extension following the
lhcbdiracx-charts pattern. This chart extends the base diracx chart with
gubbins-specific configuration including:

- Gubbins container image registry configuration
- LollygagDB database setup
- Developer mode enabled for testing
- Example hostname configuration

The chart serves as a tutorial and test example for community extensions.

* feat: adapt gubbins CI to use gubbins-charts

Update the gubbins pytest-integration CI to use the gubbins-charts umbrella
chart instead of directly using the diracx chart with value overrides.

Changes:
- Copy gubbins-charts to /tmp/ during CI setup
- Run helm dependency build on gubbins-charts before starting demo
- Add --chart-path argument to run_demo.sh pointing to gubbins-charts
- Simplify gubbins_values.yaml to only contain CI-specific overrides
- Move base gubbins configuration to gubbins-charts/values.yaml

This approach provides better separation of concerns:
- Base configuration lives in gubbins-charts (part of the extension)
- CI-specific overrides remain in gubbins_values.yaml
- Pattern is reusable for other community extensions

Related: DIRACGrid/diracx-charts#186

Author: chrisburr

.github/workflows/main.yml

@@ -167,12 +167,16 @@ jobs:
           demo_args+=("--enable-open-telemetry")
           demo_args+=("--enable-coverage")
           demo_args+=("--exit-when-done")
-          demo_args+=("--set-value" "developer.autoReload=false")
           demo_args+=("--ci-values" "../diracx-charts/demo/ci_values.yaml")
 
           declare -a demo_source_dirs=("$PWD")
 
+          # Download helm/kubectl/kind first
+          ../diracx-charts/run_demo.sh --only-download-deps
+
           if [ ${{ matrix.extension }} == 'gubbins' ]; then
+            demo_args+=("--set-value" "diracx.developer.autoReload=false")
+
             # We have to copy the code to another directory
             # and make it a git repository by itself because otherwise the
             # root in the pyproject do not make sense once mounted
@@ -182,12 +186,19 @@ jobs:
             sed -i 's@../../@@g' /tmp/gubbins/gubbins-*/pyproject.toml
             git init /tmp/gubbins/
 
+            # Copy gubbins-charts to a temporary location and build dependencies
+            cp -r ./extensions/gubbins-charts /tmp/
+            ../diracx-charts/.demo/helm dependency build /tmp/gubbins-charts
+
+            demo_args+=("--extension-chart-path" "/tmp/gubbins-charts")
             demo_args+=("--ci-values" "./extensions/gubbins_values.yaml")
             demo_args+=("--load-docker-image" "gubbins/services:dev")
             demo_source_dirs+=("/tmp/gubbins/")
           elif [ ${{ matrix.extension }} != 'diracx' ]; then
             echo "Unknown extension: ${{ matrix.extension }}"
             exit 1
+          else
+            demo_args+=("--set-value" "developer.autoReload=false")
           fi
 
           # Run the demo with the provided arguments

diracx-testing/src/diracx/testing/utils.py

@@ -529,7 +529,12 @@ def demo_urls(demo_dir):
     import yaml
 
     helm_values = yaml.safe_load((demo_dir / "values.yaml").read_text())
-    yield helm_values["developer"]["urls"]
+    try:
+        yield helm_values["developer"]["urls"]
+    except KeyError:
+        # If we're testing an extension they will have an umbrella chart so the
+        # URLs are under a "diracx" section corrosponding to the vanilla chart
+        yield helm_values["diracx"]["developer"]["urls"]
 
 
 @pytest.fixture(scope="session")

docs/dev/explanations/extensions.md

@@ -35,6 +35,7 @@ For most components you can extend them in isolation without needing to have an
 
 The exception to this is when extending `diracx-routers` you MUST also extend `diracx-client` and your client extension MUST be regenerated for every DiracX release.
 More details about this can be found in the [dedicated how to](../how-to/client-extension.md).
+Additionally, you will need an umbrella helm chart for your extension.
 
 ## Gubbins
 

extensions/gubbins-charts/.gitignore

@@ -0,0 +1,16 @@
+# Helm dependencies - these are regenerated with `helm dependency update`
+charts/
+Chart.lock
+
+# Helm package files
+*.tgz
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS files
+.DS_Store
+Thumbs.db

extensions/gubbins-charts/Chart.yaml

@@ -0,0 +1,25 @@
+apiVersion: v2
+name: gubbins
+description: Gubbins-specific DiracX Helm chart that extends the base DiracX chart
+type: application
+version: 0.1.0
+# Note: this is not reflected in the app.kubernetes.io/version label :-(
+appVersion: "v0.0.1"
+
+dependencies:
+  - name: diracx
+    version: "1.0.0"
+    repository: "https://charts.diracgrid.org/"
+maintainers:
+  - name: Gubbins DiracX Team
+    email: [email protected]
+
+keywords:
+  - diracx
+  - gubbins
+  - grid
+  - computing
+
+home: https://github.com/diracgrid/diracx
+sources:
+  - https://github.com/diracgrid/diracx

extensions/gubbins-charts/README.md

@@ -0,0 +1,74 @@
+# gubbins-charts
+
+This is an umbrella Helm chart for managing the Gubbins extension of DiracX independently of the base DiracX chart version.
+
+Gubbins is an example extension meant as a tutorial and test for extending DiracX with community-specific functionality.
+
+## Overview
+
+This chart extends the base `diracx` chart by:
+
+- Configuring gubbins-specific container images
+- Adding the LollygagDB database
+- Setting up gubbins-specific deployment settings
+
+## Prerequisites
+
+- Kubernetes cluster (1.19+)
+- Helm 3.0+
+- Access to the DiracX charts repository at https://charts.diracgrid.org/
+
+## Installation
+
+### Add the DiracX Helm repository
+
+```bash
+helm repo add diracx https://charts.diracgrid.org/
+helm repo update
+```
+
+### Install dependencies
+
+```bash
+helm dependency build
+```
+
+### Install the chart
+
+```bash
+helm install gubbins . --values values.yaml
+```
+
+### Install with custom values
+
+```bash
+helm install gubbins . --values values.yaml --values custom-values.yaml
+```
+
+## Configuration
+
+The main configuration is in `values.yaml`. Key settings include:
+
+- `diracx.global.images.services`: Container image registry for gubbins services
+- `diracx.global.images.tag`: Image tag to use (default: "dev")
+- `diracx.diracx.hostname`: Hostname for the gubbins deployment
+- `diracx.diracx.sqlDbs.dbs.LollygagDB`: Gubbins-specific database configuration
+- `diracx.developer.enabled`: Enable developer mode for testing
+
+## Upgrading
+
+```bash
+helm upgrade gubbins . --values values.yaml
+```
+
+## Uninstalling
+
+```bash
+helm uninstall gubbins
+```
+
+## Development
+
+This chart is part of the DiracX extensions ecosystem and serves as an example for communities wanting to extend DiracX functionality.
+
+For more information about creating DiracX extensions, see the [DiracX documentation](https://github.com/diracgrid/diracx).

extensions/gubbins-charts/values.yaml

@@ -0,0 +1,12 @@
+diracx:
+  developer:
+    enabled: true
+  diracx:
+    hostname: gubbinsdiracx.example.com
+    sqlDbs:
+      dbs:
+        LollygagDB:
+  global:
+    images:
+      tag: "dev"
+      services: gubbins/services

extensions/gubbins_values.yaml

@@ -1,17 +1,8 @@
-# values specific to testing gubbins
-global:
-  # Needed to be able to force pre-load the image in kind
-  # see https://kind.sigs.k8s.io/docs/user/quick-start/#loading-an-image-into-your-cluster
-  # and https://iximiuz.com/en/posts/kubernetes-kind-load-docker-image/
-  imagePullPolicy: IfNotPresent
-  images:
-    services: gubbins/services
-    tag: dev
-
-developer:
-  enabled: true
-
+# CI-specific values for testing gubbins
+# Base gubbins configuration is in gubbins-charts/values.yaml
 diracx:
-  sqlDbs:
-    dbs:
-      LollygagDB:
+  global:
+    # Needed to be able to force pre-load the image in kind
+    # see https://kind.sigs.k8s.io/docs/user/quick-start/#loading-an-image-into-your-cluster
+    # and https://iximiuz.com/en/posts/kubernetes-kind-load-docker-image/
+    imagePullPolicy: IfNotPresent