something went wrong while collecting envs [Bug]

[alikhil]

Describe the bug

GrafanaDashboard resources without envs spec field set is failed to reconcile with something went wrong while collecting envs, error: dashboard.Spec.Envs or dashboard.Spec.EnvFrom nil, can't get envs for dashboard error.

However, according to docs both fields are optional:

Version
Full semver version of the operator being used - 5.9.0

To Reproduce
Steps to reproduce the behavior:

1. Deploy operator using latest helm chart https://artifacthub.io/packages/helm/bitnami/grafana-operator
2. Create grafana crd
3. Create Dashboard resource

Example of dashboard resource

apiVersion: grafana.integreatly.org/v1beta1
kind: GrafanaDashboard
metadata:
  name: grafanadashboard-jsonnet
  namespace: promstack
spec:
  folder: "Kubernetes"
  instanceSelector:
    matchLabels:
      grafana: iponweb
  resyncPeriod: 1m

  jsonnet: |
   local grafana = import 'grafonnet/grafana.libsonnet';
   local dashboard = grafana.dashboard;
   local row = grafana.row;
   local singlestat = grafana.singlestat;
   local prometheus = grafana.prometheus;
   local template = grafana.template;

   dashboard.new(
     'JVM',
     tags=['java'],
   )
   .addTemplate(
     grafana.template.datasource(
       'PROMETHEUS_DS',
       'prometheus',
       'Prometheus',
       hide='label',
     )
   )
   .addTemplate(
     template.new(
       'env',
       '$PROMETHEUS_DS',
       'label_values(jvm_threads_current, env)',
       label='Environment',
       refresh='time',
     )
   )
   .addTemplate(
     template.new(
       'job',
       '$PROMETHEUS_DS',
       'label_values(jvm_threads_current{env="$env"}, job)',
       label='Job',
       refresh='time',
     )
   )
   .addTemplate(
     template.new(
       'instance',
       '$PROMETHEUS_DS',
       'label_values(jvm_threads_current{env="$env",job="$job"}, instance)',
       label='Instance',
       refresh='time',
     )
   )
   .addRow(
     row.new()
     .addPanel(
       singlestat.new(
         'uptime',
         format='s',
         datasource='Prometheus',
         span=2,
         valueName='current',
       )
       .addTarget(
         prometheus.target(
           'time() - process_start_time_seconds{env="$env", job="$job", instance="$instance"}',
         )
       )
     )
   )

5. See error in logs of operator

2024-05-10T10:08:39Z    ERROR   GrafanaDashboardReconciler      error fetching dashboard        {"controller": "grafanadashboard", "controllerGroup": "grafana.integreatly.org", "controllerKind": "GrafanaDashboard", "GrafanaDashboard": {"name":"grafanadashboard-jsonnet","namespace":"promstack"}, "namespace": "promstack", "name": "grafanadashboard-jsonnet", "reconcileID": "11a726b1-cf40-4164-a1ce-af226a83cbd5", "dashboard": "grafanadashboard-jsonnet", "error": "something went wrong while collecting envs, error: dashboard.Spec.Envs or dashboard.Spec.EnvFrom nil, can't get envs for dashboard: grafanadashboard-jsonnet"}
github.com/grafana/grafana-operator/v5/controllers.(*GrafanaDashboardReconciler).Reconcile
        /bitnami/blacksmith-sandox/grafana-operator-5.8.1/src/github.com/grafana-operator/grafana-operator/controllers/dashboard_controller.go:203
sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).Reconcile
        /bitnami/blacksmith-sandox/grafana-operator-5.8.1/pkg/mod/sigs.k8s.io/[email protected]/pkg/internal/controller/controller.go:119
sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).reconcileHandler
        /bitnami/blacksmith-sandox/grafana-operator-5.8.1/pkg/mod/sigs.k8s.io/[email protected]/pkg/internal/controller/controller.go:316
sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).processNextWorkItem
        /bitnami/blacksmith-sandox/grafana-operator-5.8.1/pkg/mod/sigs.k8s.io/[email protected]/pkg/internal/controller/controller.go:266
sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).Start.func2.2
        /bitnami/blacksmith-sandox/grafana-operator-5.8.1/pkg/mod/sigs.k8s.io/[email protected]/pkg/internal/controller/controller.go:227

Expected behavior
Expected to reconcile dashboard successfully.

Suspect component/Location where the bug might be occurring
I think there is a bug here which triggers throwing error on empty 'envFrom' and 'envs' fields.

Runtime:

• OS: [e.g. Linux,Fedora,Mac]
• Grafana Operator Version 5.9.0
• Environment: Kubernetes v1.27.11-gke.1062001
• Deployment type: deployed in cluster with 4.2.1 chart version

[alikhil]

Also, if I add some dummy envs like

envs:
- name: DUMMY
   value: "VALUE"

It works with any problem