cdk8s-grafana
cdk8s-grafana is a library that lets you easily define a Grafana service for your kubernetes cluster along with associated dashboards and datasources, using a high level API.
Usage
To apply the resources generated by this construct, the Grafana operator must be installed on your cluster. See https://operatorhub.io/operator/grafana-operator for full installation instructions.
The following will define a Grafana cluster connected to a Prometheus datasource:
import { Grafana } from 'cdk8s-grafana';
// inside your chart:
const grafana = new Grafana(this, 'my-grafana', {
defaultDataSource: {
name: 'Prometheus',
type: 'prometheus',
access: 'proxy',
url: 'http://prometheus-service:9090',
}
});
Basic aspects of a dashboard can be customized:
const github = grafana.addDatasource('github', ...);
const dashboard = grafana.addDashboard('my-dashboard', {
title: 'My Dashboard',
refreshRate: Duration.seconds(10),
timeRange: Duration.hours(6), // show metrics from now-6h to now
plugins: [
{
name: 'grafana-piechart-panel',
version: '1.3.6',
}
],
});
Note: the kubernetes grafana operator only supports one Grafana instance per namespace (see https://github.com/grafana-operator/grafana-operator/issues/174). This may require specifying namespaces explicitly, e.g.:
const devGrafana = new Grafana(this, 'my-grafana', {
namespace: 'dev',
});
const prodGrafana = new Grafana(this, 'my-grafana', {
namespace: 'prod',
});
The grafana operator must be installed in each namespace for the resources in that namespace to be recognized.
Security
See CONTRIBUTING for more information.
License
This project is licensed under the Apache-2.0 License.
1 maintainer
Metadata
1 maintainer
Release files for cdk8s-grafana 0.1.815
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cdk8s_grafana-0.1.815.tar.gz | 327.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cdk8s_grafana-0.1.815-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 653.7 kB
Release files / cdk8s_grafana-0.1.815.tar.gz
| Download URL | cdk8s_grafana-0.1.815.tar.gz |
|---|---|
| Size | 327.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
00e9a74511219801935b605f81baddbd8cb7abf0d92e007f4c64b4ac82d699e0
|
|
BLAKE2b-256 checksum How to use checksums |
038e887954f2d4fbd5afba3e03750548f5b8356f0cb7ef201df1924ebf94882c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.14.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 1, 2026.
Transparency logRelease files / cdk8s_grafana-0.1.815-py3-none-any.whl
| Download URL | cdk8s_grafana-0.1.815-py3-none-any.whl |
|---|---|
| Size | 325.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
753ab6f7a92876fd328d030c1bfee07239c2b14e0f4afd3c5cb30328eb585f2b
|
|
BLAKE2b-256 checksum How to use checksums |
bd09ff408c5cfff756e7e1e16ca0b2e170193c07f79bb4443fb3eed49bfb4ae8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.14.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 1, 2026.
Transparency log
