Merge pull request #203665 from KFearsoff/fix-grafana-markdown-release-notes

nixos/grafana: fix 22.11 release notes
This commit is contained in:
Maximilian Bosch 2022-12-04 22:48:57 +01:00 committed by GitHub
commit fcd4117b24
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 20 deletions

View file

@ -1124,9 +1124,9 @@ services.github-runner.serviceOverrides.SupplementaryGroups = [
<listitem> <listitem>
<para> <para>
Previously, the options Previously, the options
<xref linkend="opt-services.grafana.provision.datasources" /> <link linkend="opt-services.grafana.provision.datasources">services.grafana.provision.datasources</link>
and and
<xref linkend="opt-services.grafana.provision.dashboards" /> <link linkend="opt-services.grafana.provision.dashboards">services.grafana.provision.dashboards</link>
expected lists of datasources or dashboards for the expected lists of datasources or dashboards for the
<link xlink:href="https://grafana.com/docs/grafana/latest/administration/provisioning/">declarative <link xlink:href="https://grafana.com/docs/grafana/latest/administration/provisioning/">declarative
provisioning</link>. provisioning</link>.
@ -1139,14 +1139,14 @@ services.github-runner.serviceOverrides.SupplementaryGroups = [
<para> <para>
<emphasis role="strong">datasources</emphasis>, please <emphasis role="strong">datasources</emphasis>, please
rename your declarations to rename your declarations to
<xref linkend="opt-services.grafana.provision.datasources.settings.datasources" />. <link linkend="opt-services.grafana.provision.datasources.settings.datasources">services.grafana.provision.datasources.settings.datasources</link>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis role="strong">dashboards</emphasis>, please <emphasis role="strong">dashboards</emphasis>, please
rename your declarations to rename your declarations to
<xref linkend="opt-services.grafana.provision.dashboards.settings.providers" />. <link linkend="opt-services.grafana.provision.dashboards.settings.providers">services.grafana.provision.dashboards.settings.providers</link>.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -1159,9 +1159,9 @@ services.github-runner.serviceOverrides.SupplementaryGroups = [
Its possible to declare the Its possible to declare the
<literal>apiVersion</literal> of your dashboards and <literal>apiVersion</literal> of your dashboards and
datasources by datasources by
<xref linkend="opt-services.grafana.provision.datasources.settings.apiVersion" /> <link linkend="opt-services.grafana.provision.datasources.settings.apiVersion">services.grafana.provision.datasources.settings.apiVersion</link>
(or (or
<xref linkend="opt-services.grafana.provision.dashboards.settings.apiVersion" />). <link linkend="opt-services.grafana.provision.dashboards.settings.apiVersion">services.grafana.provision.dashboards.settings.apiVersion</link>).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -1169,9 +1169,9 @@ services.github-runner.serviceOverrides.SupplementaryGroups = [
Instead of declaring datasources and dashboards in Instead of declaring datasources and dashboards in
pure Nix, its also possible to specify configuration pure Nix, its also possible to specify configuration
files (or directories) with YAML instead using files (or directories) with YAML instead using
<xref linkend="opt-services.grafana.provision.datasources.path" /> <link linkend="opt-services.grafana.provision.datasources.path">services.grafana.provision.datasources.path</link>
(or (or
<xref linkend="opt-services.grafana.provision.dashboards.path" />. <link linkend="opt-services.grafana.provision.dashboards.path">services.grafana.provision.dashboards.path</link>.
This is useful when having provisioning files from This is useful when having provisioning files from
non-NixOS Grafana instances that you also want to non-NixOS Grafana instances that you also want to
deploy to NixOS. deploy to NixOS.
@ -1186,9 +1186,9 @@ services.github-runner.serviceOverrides.SupplementaryGroups = [
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<xref linkend="opt-services.grafana.provision.notifiers" /> <link linkend="opt-services.grafana.provision.notifiers">services.grafana.provision.notifiers</link>
is not affected by this change because this feature is is not affected by this change because this feature is
deprecated by Grafana and will probably removed in deprecated by Grafana and will probably be removed in
Grafana 10. Its recommended to use Grafana 10. Its recommended to use
<literal>services.grafana.provision.alerting.contactPoints</literal> <literal>services.grafana.provision.alerting.contactPoints</literal>
instead. instead.

View file

@ -340,32 +340,32 @@ In addition to numerous new and upgraded packages, this release includes the fol
Alternatively you can also set all your values from `extraOptions` to Alternatively you can also set all your values from `extraOptions` to
`systemd.services.grafana.environment`, make sure you don't forget to add `systemd.services.grafana.environment`, make sure you don't forget to add
the `GF_` prefix though! the `GF_` prefix though!
- Previously, the options [](#opt-services.grafana.provision.datasources) and - Previously, the options [services.grafana.provision.datasources](#opt-services.grafana.provision.datasources) and
[](#opt-services.grafana.provision.dashboards) expected lists of datasources [services.grafana.provision.dashboards](#opt-services.grafana.provision.dashboards) expected lists of datasources
or dashboards for the [declarative provisioning](https://grafana.com/docs/grafana/latest/administration/provisioning/). or dashboards for the [declarative provisioning](https://grafana.com/docs/grafana/latest/administration/provisioning/).
To declare lists of To declare lists of
- **datasources**, please rename your declarations to [](#opt-services.grafana.provision.datasources.settings.datasources). - **datasources**, please rename your declarations to [services.grafana.provision.datasources.settings.datasources](#opt-services.grafana.provision.datasources.settings.datasources).
- **dashboards**, please rename your declarations to [](#opt-services.grafana.provision.dashboards.settings.providers). - **dashboards**, please rename your declarations to [services.grafana.provision.dashboards.settings.providers](#opt-services.grafana.provision.dashboards.settings.providers).
This change was made to support more features for that: This change was made to support more features for that:
- It's possible to declare the `apiVersion` of your dashboards and datasources - It's possible to declare the `apiVersion` of your dashboards and datasources
by [](#opt-services.grafana.provision.datasources.settings.apiVersion) (or by [services.grafana.provision.datasources.settings.apiVersion](#opt-services.grafana.provision.datasources.settings.apiVersion) (or
[](#opt-services.grafana.provision.dashboards.settings.apiVersion)). [services.grafana.provision.dashboards.settings.apiVersion](#opt-services.grafana.provision.dashboards.settings.apiVersion)).
- Instead of declaring datasources and dashboards in pure Nix, it's also possible - Instead of declaring datasources and dashboards in pure Nix, it's also possible
to specify configuration files (or directories) with YAML instead using to specify configuration files (or directories) with YAML instead using
[](#opt-services.grafana.provision.datasources.path) (or [services.grafana.provision.datasources.path](#opt-services.grafana.provision.datasources.path) (or
[](#opt-services.grafana.provision.dashboards.path). This is useful when having [services.grafana.provision.dashboards.path](#opt-services.grafana.provision.dashboards.path). This is useful when having
provisioning files from non-NixOS Grafana instances that you also want to provisioning files from non-NixOS Grafana instances that you also want to
deploy to NixOS. deploy to NixOS.
__Note:__ secrets from these files will be leaked into the store unless you use a __Note:__ secrets from these files will be leaked into the store unless you use a
[**file**-provider or env-var](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#file-provider) for secrets! [**file**-provider or env-var](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#file-provider) for secrets!
- [](#opt-services.grafana.provision.notifiers) is not affected by this change because - [services.grafana.provision.notifiers](#opt-services.grafana.provision.notifiers) is not affected by this change because
this feature is deprecated by Grafana and will probably removed in Grafana 10. this feature is deprecated by Grafana and will probably be removed in Grafana 10.
It's recommended to use `services.grafana.provision.alerting.contactPoints` instead. It's recommended to use `services.grafana.provision.alerting.contactPoints` instead.
- The `services.grafana.provision.alerting` option was added. It includes suboptions for every alerting-related objects (with the exception of `notifiers`), which means it's now possible to configure modern Grafana alerting declaratively. - The `services.grafana.provision.alerting` option was added. It includes suboptions for every alerting-related objects (with the exception of `notifiers`), which means it's now possible to configure modern Grafana alerting declaratively.