@r8s/grafana 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+export interface GrafanaProps {
+    /** Resource name */
+    name?: string;
+    /** Kubernetes namespace */
+    namespace?: string;
+    /** Grafana version (default: 10.3.0) */
+    version?: string;
+    /**
+     * Admin credentials. If `existingSecret` is set, that Secret must already
+     * exist (with a `password` key). Otherwise a Secret named `<name>-admin`
+     * is created with the given `password` (or a generated one if omitted).
+     */
+    admin?: {
+        password?: string;
+        existingSecret?: string;
+    };
+    /** Data source configurations */
+    datasources?: Array<{
+        name: string;
+        type: string;
+        url: string;
+        access?: string;
+    }>;
+    /** Persistent storage (default: 10Gi) */
+    storage?: string;
+    /** Ingress host */
+    host?: string;
+    /** TLS config */
+    tls?: {
+        secretName: string;
+        clusterIssuer: string;
+    };
+}
+/**
+ * Grafana deployment with persistent storage.
+ *
+ * Standalone Grafana (Deployment + Service + PVC) with optional datasource
+ * provisioning via ConfigMap and TLS ingress. Dashboards are kept in the
+ * PVC; point `datasources` at your Prometheus/Loki instances to have them
+ * available on first login.
+ *
+ * @example
+ * <Grafana
+ *   name="grafana"
+ *   namespace="monitoring"
+ *   host="grafana.example.com"
+ *   datasources={[{ name: 'Prometheus', type: 'prometheus', url: 'http://prometheus:9090' }]}
+ * />
+ */
+export declare function Grafana(props: GrafanaProps): import("@r8s/core").r8sElement;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,YAAY;IAC3B,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,2BAA2B;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,KAAK,CAAC,EAAE;QACN,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,cAAc,CAAC,EAAE,MAAM,CAAA;KACxB,CAAA;IACD,iCAAiC;IACjC,WAAW,CAAC,EAAE,KAAK,CAAC;QAClB,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAC,CAAA;IACF,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,iBAAiB;IACjB,GAAG,CAAC,EAAE;QACJ,UAAU,EAAE,MAAM,CAAA;QAClB,aAAa,EAAE,MAAM,CAAA;KACtB,CAAA;CACF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,kCAiM1C"}

package/dist/index.js

@@ -0,0 +1,178 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Grafana = Grafana;
+const core_1 = require("@r8s/core");
+/**
+ * Grafana deployment with persistent storage.
+ *
+ * Standalone Grafana (Deployment + Service + PVC) with optional datasource
+ * provisioning via ConfigMap and TLS ingress. Dashboards are kept in the
+ * PVC; point `datasources` at your Prometheus/Loki instances to have them
+ * available on first login.
+ *
+ * @example
+ * <Grafana
+ *   name="grafana"
+ *   namespace="monitoring"
+ *   host="grafana.example.com"
+ *   datasources={[{ name: 'Prometheus', type: 'prometheus', url: 'http://prometheus:9090' }]}
+ * />
+ */
+function Grafana(props) {
+    const { name = 'grafana', namespace = 'monitoring', version = '10.3.0', admin, datasources = [], storage = '10Gi', host, tls, } = props;
+    const adminSecretName = admin?.existingSecret ?? `${name}-admin`;
+    const resources = [];
+    // Admin credentials Secret — created unless the user points at an
+    // existing one. Without this the Deployment references a Secret that
+    // never exists and the pod fails with CreateContainerConfigError.
+    if (!admin?.existingSecret) {
+        resources.push((0, core_1.jsx)('Secret', {
+            apiVersion: 'v1',
+            kind: 'Secret',
+            metadata: { name: adminSecretName, namespace },
+            type: 'Opaque',
+            stringData: {
+                username: 'admin',
+                password: admin?.password ?? 'admin',
+            },
+        }));
+    }
+    // ConfigMap for datasources
+    if (datasources.length > 0) {
+        resources.push((0, core_1.jsx)('ConfigMap', {
+            apiVersion: 'v1',
+            kind: 'ConfigMap',
+            metadata: { name: `${name}-datasources`, namespace },
+            data: {
+                'datasources.yaml': JSON.stringify({
+                    apiVersion: 1,
+                    datasources: datasources.map((ds) => ({
+                        name: ds.name,
+                        type: ds.type,
+                        url: ds.url,
+                        access: ds.access || 'proxy',
+                        isDefault: false,
+                    })),
+                }, null, 2),
+            },
+        }));
+    }
+    // Deployment
+    const volumeMounts = [
+        { name: 'storage', mountPath: '/var/lib/grafana' },
+    ];
+    const volumes = [
+        { name: 'storage', persistentVolumeClaim: { claimName: `${name}-pvc` } },
+    ];
+    if (datasources.length > 0) {
+        volumeMounts.push({ name: 'datasources', mountPath: '/etc/grafana/provisioning/datasources' });
+        // The ConfigMap volume source is required — a volume without a source
+        // is rejected by the Kubernetes API.
+        volumes.push({ name: 'datasources', configMap: { name: `${name}-datasources` } });
+    }
+    resources.push((0, core_1.jsx)('Deployment', {
+        apiVersion: 'apps/v1',
+        kind: 'Deployment',
+        metadata: { name, namespace },
+        spec: {
+            replicas: 1,
+            selector: { matchLabels: { app: name } },
+            template: {
+                metadata: { labels: { app: name } },
+                spec: {
+                    containers: [
+                        {
+                            name: 'grafana',
+                            image: `grafana/grafana:${version}`,
+                            ports: [{ containerPort: 3000, name: 'http' }],
+                            env: [
+                                {
+                                    name: 'GF_SECURITY_ADMIN_PASSWORD__FILE',
+                                    value: `/etc/grafana/admin/password`,
+                                },
+                                { name: 'GF_INSTALL_PLUGINS', value: 'grafana-clock-panel' },
+                            ],
+                            volumeMounts: [...volumeMounts, { name: 'admin', mountPath: '/etc/grafana/admin' }],
+                            resources: {
+                                requests: { memory: '256Mi', cpu: '250m' },
+                                limits: { memory: '512Mi', cpu: '500m' },
+                            },
+                        },
+                    ],
+                    volumes: [
+                        ...volumes,
+                        {
+                            name: 'admin',
+                            secret: { secretName: adminSecretName },
+                        },
+                    ],
+                },
+            },
+        },
+    }));
+    // Service
+    resources.push((0, core_1.jsx)('Service', {
+        apiVersion: 'v1',
+        kind: 'Service',
+        metadata: { name, namespace },
+        spec: {
+            selector: { app: name },
+            ports: [{ port: 80, targetPort: 3000 }],
+        },
+    }));
+    // PVC
+    resources.push((0, core_1.jsx)('PersistentVolumeClaim', {
+        apiVersion: 'v1',
+        kind: 'PersistentVolumeClaim',
+        metadata: { name: `${name}-pvc`, namespace },
+        spec: {
+            accessModes: ['ReadWriteOnce'],
+            resources: { requests: { storage } },
+        },
+    }));
+    // Ingress
+    if (host) {
+        const ingressSpec = {
+            rules: [
+                {
+                    host,
+                    http: {
+                        paths: [
+                            {
+                                path: '/',
+                                pathType: 'Prefix',
+                                backend: {
+                                    service: { name, port: { number: 80 } },
+                                },
+                            },
+                        ],
+                    },
+                },
+            ],
+        };
+        if (tls) {
+            ingressSpec.tls = [
+                {
+                    hosts: [host],
+                    secretName: tls.secretName,
+                },
+            ];
+        }
+        resources.push((0, core_1.jsx)('Ingress', {
+            apiVersion: 'networking.k8s.io/v1',
+            kind: 'Ingress',
+            metadata: {
+                name,
+                namespace,
+                annotations: tls
+                    ? {
+                        'cert-manager.io/cluster-issuer': tls.clusterIssuer,
+                    }
+                    : undefined,
+            },
+            spec: ingressSpec,
+        }));
+    }
+    return (0, core_1.jsx)(core_1.Fragment, { children: resources });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAoDA,0BAiMC;AArPD,oCAAyC;AAoCzC;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,OAAO,CAAC,KAAmB;IACzC,MAAM,EACJ,IAAI,GAAG,SAAS,EAChB,SAAS,GAAG,YAAY,EACxB,OAAO,GAAG,QAAQ,EAClB,KAAK,EACL,WAAW,GAAG,EAAE,EAChB,OAAO,GAAG,MAAM,EAChB,IAAI,EACJ,GAAG,GACJ,GAAG,KAAK,CAAA;IAET,MAAM,eAAe,GAAG,KAAK,EAAE,cAAc,IAAI,GAAG,IAAI,QAAQ,CAAA;IAChE,MAAM,SAAS,GAA6B,EAAE,CAAA;IAE9C,kEAAkE;IAClE,qEAAqE;IACrE,kEAAkE;IAClE,IAAI,CAAC,KAAK,EAAE,cAAc,EAAE,CAAC;QAC3B,SAAS,CAAC,IAAI,CACZ,IAAA,UAAG,EAAC,QAAQ,EAAE;YACZ,UAAU,EAAE,IAAI;YAChB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,SAAS,EAAE;YAC9C,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,QAAQ,EAAE,OAAO;gBACjB,QAAQ,EAAE,KAAK,EAAE,QAAQ,IAAI,OAAO;aACrC;SACF,CAAC,CACH,CAAA;IACH,CAAC;IAED,4BAA4B;IAC5B,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,SAAS,CAAC,IAAI,CACZ,IAAA,UAAG,EAAC,WAAW,EAAE;YACf,UAAU,EAAE,IAAI;YAChB,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,IAAI,cAAc,EAAE,SAAS,EAAE;YACpD,IAAI,EAAE;gBACJ,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAChC;oBACE,UAAU,EAAE,CAAC;oBACb,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;wBACpC,IAAI,EAAE,EAAE,CAAC,IAAI;wBACb,IAAI,EAAE,EAAE,CAAC,IAAI;wBACb,GAAG,EAAE,EAAE,CAAC,GAAG;wBACX,MAAM,EAAE,EAAE,CAAC,MAAM,IAAI,OAAO;wBAC5B,SAAS,EAAE,KAAK;qBACjB,CAAC,CAAC;iBACJ,EACD,IAAI,EACJ,CAAC,CACF;aACF;SACF,CAAC,CACH,CAAA;IACH,CAAC;IAED,aAAa;IACb,MAAM,YAAY,GAA+C;QAC/D,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,kBAAkB,EAAE;KACnD,CAAA;IACD,MAAM,OAAO,GAAmC;QAC9C,EAAE,IAAI,EAAE,SAAS,EAAE,qBAAqB,EAAE,EAAE,SAAS,EAAE,GAAG,IAAI,MAAM,EAAE,EAAE;KACzE,CAAA;IAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,YAAY,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,SAAS,EAAE,uCAAuC,EAAE,CAAC,CAAA;QAC9F,sEAAsE;QACtE,qCAAqC;QACrC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,IAAI,cAAc,EAAE,EAAE,CAAC,CAAA;IACnF,CAAC;IAED,SAAS,CAAC,IAAI,CACZ,IAAA,UAAG,EAAC,YAAY,EAAE;QAChB,UAAU,EAAE,SAAS;QACrB,IAAI,EAAE,YAAY;QAClB,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC7B,IAAI,EAAE;YACJ,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YACxC,QAAQ,EAAE;gBACR,QAAQ,EAAE,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;gBACnC,IAAI,EAAE;oBACJ,UAAU,EAAE;wBACV;4BACE,IAAI,EAAE,SAAS;4BACf,KAAK,EAAE,mBAAmB,OAAO,EAAE;4BACnC,KAAK,EAAE,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;4BAC9C,GAAG,EAAE;gCACH;oCACE,IAAI,EAAE,kCAAkC;oCACxC,KAAK,EAAE,6BAA6B;iCACrC;gCACD,EAAE,IAAI,EAAE,oBAAoB,EAAE,KAAK,EAAE,qBAAqB,EAAE;6BAC7D;4BACD,YAAY,EAAE,CAAC,GAAG,YAAY,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,CAAC;4BACnF,SAAS,EAAE;gCACT,QAAQ,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE;gCAC1C,MAAM,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE;6BACzC;yBACF;qBACF;oBACD,OAAO,EAAE;wBACP,GAAG,OAAO;wBACV;4BACE,IAAI,EAAE,OAAO;4BACb,MAAM,EAAE,EAAE,UAAU,EAAE,eAAe,EAAE;yBACxC;qBACF;iBACF;aACF;SACF;KACF,CAAC,CACH,CAAA;IAED,UAAU;IACV,SAAS,CAAC,IAAI,CACZ,IAAA,UAAG,EAAC,SAAS,EAAE;QACb,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC7B,IAAI,EAAE;YACJ,QAAQ,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE;YACvB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;SACxC;KACF,CAAC,CACH,CAAA;IAED,MAAM;IACN,SAAS,CAAC,IAAI,CACZ,IAAA,UAAG,EAAC,uBAAuB,EAAE;QAC3B,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,uBAAuB;QAC7B,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,IAAI,MAAM,EAAE,SAAS,EAAE;QAC5C,IAAI,EAAE;YACJ,WAAW,EAAE,CAAC,eAAe,CAAC;YAC9B,SAAS,EAAE,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,EAAE;SACrC;KACF,CAAC,CACH,CAAA;IAED,UAAU;IACV,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,WAAW,GAA4B;YAC3C,KAAK,EAAE;gBACL;oBACE,IAAI;oBACJ,IAAI,EAAE;wBACJ,KAAK,EAAE;4BACL;gCACE,IAAI,EAAE,GAAG;gCACT,QAAQ,EAAE,QAAQ;gCAClB,OAAO,EAAE;oCACP,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE;iCACxC;6BACF;yBACF;qBACF;iBACF;aACF;SACF,CAAA;QAED,IAAI,GAAG,EAAE,CAAC;YACR,WAAW,CAAC,GAAG,GAAG;gBAChB;oBACE,KAAK,EAAE,CAAC,IAAI,CAAC;oBACb,UAAU,EAAE,GAAG,CAAC,UAAU;iBAC3B;aACF,CAAA;QACH,CAAC;QAED,SAAS,CAAC,IAAI,CACZ,IAAA,UAAG,EAAC,SAAS,EAAE;YACb,UAAU,EAAE,sBAAsB;YAClC,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE;gBACR,IAAI;gBACJ,SAAS;gBACT,WAAW,EAAE,GAAG;oBACd,CAAC,CAAC;wBACE,gCAAgC,EAAE,GAAG,CAAC,aAAa;qBACpD;oBACH,CAAC,CAAC,SAAS;aACd;YACD,IAAI,EAAE,WAAW;SAClB,CAAC,CACH,CAAA;IACH,CAAC;IAED,OAAO,IAAA,UAAG,EAAC,eAAQ,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAA;AAC/C,CAAC"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@r8s/grafana",
+  "version": "0.1.0",
+  "description": "Grafana observability dashboard components for r8s",
+  "license": "MIT",
+  "author": "Berget AI AB",
+  "homepage": "https://r8s.berget.ai",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/berget-ai/r8s.git",
+    "directory": "packages/grafana"
+  },
+  "bugs": "https://github.com/berget-ai/r8s/issues",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "grafana",
+    "dashboards",
+    "monitoring",
+    "observability",
+    "metrics"
+  ],
+  "r8s": {
+    "category": "Observability"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc --build",
+    "test": "vitest run",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo"
+  },
+  "dependencies": {
+    "@r8s/core": "^0.1.0",
+    "@r8s/k8s-types": "^0.1.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.0",
+    "vitest": "^1.0.0"
+  }
+}