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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cdk8s_grafana-0.1.797.tar.gz.
File metadata
- Download URL: cdk8s_grafana-0.1.797.tar.gz
- Upload date:
- Size: 327.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2fc9c0c8c6943cbdd5aeb2842b55ffbb0d6a4a05bdbd6027361de7e03f16380e
|
|
| MD5 |
7b53dd017bbbf62bfcb84dcffc362992
|
|
| BLAKE2b-256 |
8bf6df96cd1d54bda24fcd4248ec399b6ffdd757e173d0f985991beabd61a591
|
Provenance
The following attestation bundles were made for cdk8s_grafana-0.1.797.tar.gz:
Publisher:
release.yml on cdk8s-team/cdk8s-grafana
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cdk8s_grafana-0.1.797.tar.gz -
Subject digest:
2fc9c0c8c6943cbdd5aeb2842b55ffbb0d6a4a05bdbd6027361de7e03f16380e - Sigstore transparency entry: 2190113151
- Sigstore integration time:
-
Permalink:
cdk8s-team/cdk8s-grafana@3944068b39cfc16f1a7028e981576f3969a8a348 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/cdk8s-team
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@3944068b39cfc16f1a7028e981576f3969a8a348 -
Trigger Event:
push
-
Statement type:
File details
Details for the file cdk8s_grafana-0.1.797-py3-none-any.whl.
File metadata
- Download URL: cdk8s_grafana-0.1.797-py3-none-any.whl
- Upload date:
- Size: 325.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a1d7bb49df2e01cc9c555fece0daedcdc3e8a7c69e9b7d1148f111043c89ca6e
|
|
| MD5 |
de04b0b65a0337f784af30570dcc1293
|
|
| BLAKE2b-256 |
8f50ea86e9460e2c349466aa0262e671a7fbf901a65bb52196939b1898b89823
|
Provenance
The following attestation bundles were made for cdk8s_grafana-0.1.797-py3-none-any.whl:
Publisher:
release.yml on cdk8s-team/cdk8s-grafana
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cdk8s_grafana-0.1.797-py3-none-any.whl -
Subject digest:
a1d7bb49df2e01cc9c555fece0daedcdc3e8a7c69e9b7d1148f111043c89ca6e - Sigstore transparency entry: 2190113138
- Sigstore integration time:
-
Permalink:
cdk8s-team/cdk8s-grafana@3944068b39cfc16f1a7028e981576f3969a8a348 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/cdk8s-team
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@3944068b39cfc16f1a7028e981576f3969a8a348 -
Trigger Event:
push
-
Statement type:
