docs: document JaaS example #2370
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sebhoss
requested review from
Baarsgaard,
hubeadmin,
ishanjainn,
nissessenap,
pb82,
theSuess and
weisdd
as code owners
github-actions
bot
added
the
documentation
Signed-off-by: Sebastian Hoß <seb@xn--ho-hia.de>
Author
|
Fixed missing newline at end of files |
theSuess
requested changes
Dec 18, 2025
Collaborator
theSuess
left a comment
theSuess
left a comment
There was a problem hiding this comment.
Thanks for this! I left some minor comments but overall this looks godd!
|
|
||
| ### Jsonnet | ||
|
|
||
| The Jsonnet dashboard type is deprecated. It uses the old and now unmaintained [grafonnet-lib](https://github.com/grafana/grafonnet-lib) library. Users who rely on Jsonnet based dashboards should switch to [JaaS](#jaas) instead which supports the new [grafonnet](https://github.com/grafana/grafonnet) library as well as any additional custom libraries you have created yourself. See the [discussion](https://github.com/grafana/grafana-operator/discussions/2171) for more details. |
Collaborator
There was a problem hiding this comment.
Suggested change
| The Jsonnet dashboard type is deprecated. It uses the old and now unmaintained [grafonnet-lib](https://github.com/grafana/grafonnet-lib) library. Users who rely on Jsonnet based dashboards should switch to [JaaS](#jaas) instead which supports the new [grafonnet](https://github.com/grafana/grafonnet) library as well as any additional custom libraries you have created yourself. See the [discussion](https://github.com/grafana/grafana-operator/discussions/2171) for more details. | |
| The Jsonnet dashboard type is targeted for deprecation. It uses the old and now unmaintained [grafonnet-lib](https://github.com/grafana/grafonnet-lib) library. Users who rely on Jsonnet based dashboards are encouraged to evaulaute the jsonnet expressions beforehand (using tooling like [tanka](https://tanka.dev) or [kubecfg](https://github.com/kubecfg/kubecfg)) or switch to [Jsonnet-as-a-Service](#jaas) instead which supports the new [grafonnet](https://github.com/grafana/grafonnet) library as well as any additional custom libraries you have created yourself. See the [discussion](https://github.com/grafana/grafana-operator/discussions/2171) for more details. |
| url: "http://jaas.jaas.svc.cluster.local:8080/jsonnet/your-dashboard" | ||
| ``` | ||
|
|
||
| [Example documentation](./jaas/readme). |
Collaborator
There was a problem hiding this comment.
Suggested change
| [Example documentation](./jaas/readme). | |
| [Full example, including JaaS setup](./jaas/readme). |
|
|
||
| ## Write your dashboards | ||
|
|
||
| The JaaS Helm chart includes [Grafonnet](https://github.com/grafana/grafonnet) and [other required libraries](https://github.com/metio/jsonnet-oci-images) as OCI volumes to write Grafana dashboards using Jsonnet. However, since Jsonnet is a superset of JSON, you can use JaaS to deliver your JSON based dashboards as well. This allows you to export an existing dashboard using the Grafana UI, package it as an OCI object, and expose it through JaaS. |
Collaborator
There was a problem hiding this comment.
Suggested change
| The JaaS Helm chart includes [Grafonnet](https://github.com/grafana/grafonnet) and [other required libraries](https://github.com/metio/jsonnet-oci-images) as OCI volumes to write Grafana dashboards using Jsonnet. However, since Jsonnet is a superset of JSON, you can use JaaS to deliver your JSON based dashboards as well. This allows you to export an existing dashboard using the Grafana UI, package it as an OCI object, and expose it through JaaS. | |
| The JaaS Helm chart includes [Grafonnet](https://github.com/grafana/grafonnet) and [other required libraries](https://github.com/metio/jsonnet-oci-images) as OCI volumes to write Grafana dashboards using Jsonnet. |
Not sure if this is relevant
|
|
||
| When using Jsonnet to define your dashboards, you will most likely want to use Grafonnet which is exposed like this in JaaS: | ||
|
|
||
| {{< readfile file="imports.jsonnet" code="true" lang="jsonnet" >}} |
Collaborator
There was a problem hiding this comment.
Since this file is pretty short and not useful on its own, this should be an inline codeblock instead.
|
|
||
| {{< readfile file="dashboard.yaml" code="true" lang="yaml" >}} | ||
|
|
||
| The name `your-dashboard` must match of the snippets you added to JaaS, or otherwise you will get a 404 response. |
Collaborator
There was a problem hiding this comment.
Suggested change
| The name `your-dashboard` must match of the snippets you added to JaaS, or otherwise you will get a 404 response. | |
| The name `your-dashboard` must match one of the snippets you added to JaaS. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds documentation on how to use JaaS as discussed in #2171.