chore(plutono): update docs and include resources across namespaces (#…

…331) * feat(plutono): search dashboards and datasources in all namespaces * docs(plutono): add more examples how to configure * chore(plutono): bump plugindefinition * docs(plutono): take suggestion Co-authored-by: Tommy Sauer <[email protected]> --------- Co-authored-by: Tommy Sauer <[email protected]>
cloudoperators · Aug 20, 2024 · 3babe01 · 3babe01
1 parent 84603fc
commit 3babe01
Show file tree

Hide file tree

Showing 4 changed files with 82 additions and 54 deletions.
diff --git a/plutono/README.md b/plutono/README.md
@@ -21,11 +21,11 @@ The plugin works by factory default with anonymous access enabled. If you use th
 
 **Step 1: Add your dashboards**
 
-Dashboards are selected from `ConfigMaps` across namespaces. The plugin searches for `ConfigMaps` with the label `plutono-dashboard: "true"` and imports them into Plutono. The `ConfigMap` should contain a key like `my-dashboard.json` with the dashboard JSON content.
+Dashboards are selected from `ConfigMaps` across namespaces. The plugin searches for `ConfigMaps` with the label `plutono-dashboard: "true"` and imports them into Plutono. The `ConfigMap` must contain a key like `my-dashboard.json` with the dashboard JSON content. [Example](https://github.com/cloudoperators/greenhouse-extensions/blob/main/plutono/README.md#example-dashboard-config)
 
 **Step 2: Add your datasources**
 
-Data sources are selected from `Secrets` across namespaces. The plugin searches for `Secrets` with the label `plutono-dashboard: "true"` and imports them into Plutono. The `Secrets` should contain valid datasource configuration YAML like [example-datasource-config-file](http://docs.grafana.org/administration/provisioning/#example-datasource-config-file).
+Data sources are selected from `Secrets` across namespaces. The plugin searches for `Secrets` with the label `plutono-dashboard: "true"` and imports them into Plutono. The `Secrets` should contain valid datasource configuration YAML. [Example](https://github.com/cloudoperators/greenhouse-extensions/blob/main/plutono/README.md#example-datasource-config)
 
 ## Configuration
 
@@ -405,82 +405,110 @@ Should you aim for reloading datasources in Plutono each time the config is chan
 Secrets are recommended over configmaps for this usecase because datasources usually contain private
 data like usernames and passwords. Secrets are the more appropriate cluster resource to manage those.
 
-Example values to add a postgres datasource as a kubernetes secret:
+#### Example datasource config:
 
 ```yaml
 apiVersion: v1
 kind: Secret
 metadata:
   name: plutono-datasources
   labels:
-    plutono-datasource: "true" # default value for: sidecar.datasources.label
+    # default value for: sidecar.datasources.label
+    plutono-datasource: "true"
 stringData:
-  pg-db.yaml: |-
+  datasources.yaml: |-
     apiVersion: 1
     datasources:
-      - name: My pg db datasource
-        type: postgres
-        url: my-postgresql-db:5432
-        user: db-readonly-user
-        secureJsonData:
-          password: 'SUperSEcretPa$$word'
+      - name: my-prometheus 
+        type: prometheus
+        access: proxy
+        orgId: 1
+        url: my-url-domain:9090
+        isDefault: false
         jsonData:
-          database: my_datase
-          sslmode: 'disable' # disable/require/verify-ca/verify-full
-          maxOpenConns: 0 # Plutono v5.4+
-          maxIdleConns: 2 # Plutono v5.4+
-          connMaxLifetime: 14400 # Plutono v5.4+
-          postgresVersion: 1000 # 903=9.3, 904=9.4, 905=9.5, 906=9.6, 1000=10
-          timescaledb: false
-        # <bool> allow users to edit datasources from the UI.
+          httpMethod: 'POST'
         editable: false
 ```
 
+**NOTE:** If you might include credentials in your datasource configuration, make sure to not use stringdata but base64 encoded data instead.
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: my-datasource
+  labels:
+    plutono-datasource: "true"
+data:
+  # The key must contain a unique name and the .yaml file type
+  my-datasource.yaml: {{ include (print $.Template.BasePath "my-datasource.yaml") . | b64enc }}
+```
+
 Example values to add a datasource adapted from [Grafana](http://docs.grafana.org/administration/provisioning/#example-datasource-config-file):
 
 ```yaml
 datasources:
  datasources.yaml:
-   apiVersion: 1
-   datasources:
-      # <string, required> name of the datasource. Required
-    - name: Graphite
-      # <string, required> datasource type. Required
-      type: graphite
-      # <string, required> access mode. proxy or direct (Server or Browser in the UI). Required
+  apiVersion: 1
+  datasources:
+      # <string, required> Sets the name you use to refer to
+      # the data source in panels and queries.
+    - name: my-prometheus 
+      # <string, required> Sets the data source type.
+      type: prometheus
+      # <string, required> Sets the access mode, either
+      # proxy or direct (Server or Browser in the UI).
+      # Some data sources are incompatible with any setting
+      # but proxy (Server).
       access: proxy
-      # <int> org id. will default to orgId 1 if not specified
+      # <int> Sets the organization id. Defaults to orgId 1.
       orgId: 1
-      # <string> url
-      url: http://localhost:8080
-      # <string> database password, if used
-      password:
-      # <string> database user, if used
+      # <string> Sets a custom UID to reference this
+      # data source in other parts of the configuration.
+      # If not specified, Plutono generates one.
+      uid:
+      # <string> Sets the data source's URL, including the
+      # port.
+      url: my-url-domain:9090
+      # <string> Sets the database user, if necessary.
       user:
-      # <string> database name, if used
+      # <string> Sets the database name, if necessary.
       database:
-      # <bool> enable/disable basic auth
+      # <bool> Enables basic authorization.
       basicAuth:
-      # <string> basic auth username
+      # <string> Sets the basic authorization username.
       basicAuthUser:
-      # <string> basic auth password
-      basicAuthPassword:
-      # <bool> enable/disable with credentials headers
+      # <bool> Enables credential headers.
       withCredentials:
-      # <bool> mark as default datasource. Max one per org
-      isDefault:
-      # <map> fields that will be converted to json and stored in json_data
+      # <bool> Toggles whether the data source is pre-selected
+      # for new panels. You can set only one default
+      # data source per organization.
+      isDefault: false
+      # <map> Fields to convert to JSON and store in jsonData.
       jsonData:
-         graphiteVersion: "1.1"
-         tlsAuth: true
-         tlsAuthWithCACert: true
-      # <string> json object of data that will be encrypted.
+        httpMethod: 'POST'
+        # <bool> Enables TLS authentication using a client
+        # certificate configured in secureJsonData.
+        # tlsAuth: true
+        # <bool> Enables TLS authentication using a CA
+        # certificate.
+        # tlsAuthWithCACert: true
+      # <map> Fields to encrypt before storing in jsonData.
       secureJsonData:
-        tlsCACert: "..."
-        tlsClientCert: "..."
-        tlsClientKey: "..."
+        # <string> Defines the CA cert, client cert, and
+        # client key for encrypted authentication.
+        # tlsCACert: '...'
+        # tlsClientCert: '...'
+        # tlsClientKey: '...'
+        # <string> Sets the database password, if necessary.
+        # password:
+        # <string> Sets the basic authorization password.
+        # basicAuthPassword:
+      # <int> Sets the version. Used to compare versions when
+      # updating. Ignored when creating a new data source.
       version: 1
-      # <bool> allow users to edit datasources from the UI.
+      # <bool> Allows users to edit data sources from the
+      # Plutono UI.
       editable: false
 ```
 

diff --git a/plutono/charts/Chart.yaml b/plutono/charts/Chart.yaml
@@ -3,7 +3,7 @@
 
 apiVersion: v2
 name: plutono
-version: 0.1.1
+version: 0.1.2
 description: Plutono is a fork of Grafana v7.5.17 keeping the Apache License
 type: application
 maintainers:

diff --git a/plutono/charts/values.yaml b/plutono/charts/values.yaml
@@ -942,7 +942,7 @@ plutono:
       # Namespaces list. If specified, the sidecar will search for config-maps/secrets inside these namespaces.
       # Otherwise the namespace in which the sidecar is running will be used.
       # It's also possible to specify ALL to search in all namespaces.
-      searchNamespace: null
+      searchNamespace: ALL
       # Method to use to detect ConfigMap changes. With WATCH the sidecar will do a WATCH requests, with SLEEP it will list all ConfigMaps, then sleep for 60 seconds.
       watchMethod: WATCH
       # search in configmap, secret or both
@@ -1015,7 +1015,7 @@ plutono:
       # If specified, the sidecar will search for datasource config-maps inside this namespace.
       # Otherwise the namespace in which the sidecar is running will be used.
       # It's also possible to specify ALL to search in all namespaces
-      searchNamespace: null
+      searchNamespace: ALL
       # Method to use to detect ConfigMap changes. With WATCH the sidecar will do a WATCH requests, with SLEEP it will list all ConfigMaps, then sleep for 60 seconds.
       watchMethod: WATCH
       # search in configmap, secret or both

diff --git a/plutono/plugindefinition.yaml b/plutono/plugindefinition.yaml
@@ -6,8 +6,8 @@ metadata:
   name: plutono
 spec:
   description: Plutono is a fork of Grafana 7.5.17 limited to maintenance and security updates.
-  version: 0.1.1
+  version: 0.1.2
   helmChart:
     name: plutono
     repository: oci://ghcr.io/cloudoperators/greenhouse-extensions/charts
-    version: 0.1.1
+    version: 0.1.2