128 Commits

Author SHA1 Message Date
667cbd626c Alerting docs: adds display names to fixed roles for RBAC (#92357)
* Alerting docs: adds display names to fixed roles for RBAC

* ran prettier

* updates descriptions

* preposition update

* ran prettier
2024-08-27 09:23:04 +02:00
2ba930ab1f Alerting Docs: Monitor your high availability setup (#92063)
* Alerting Docs: Monitor your high availability setup

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Shorten links

* Update/reorder a bit the description about alertmanager gossiping

* Update `alertmanager_peer_position` description

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-08-27 08:01:14 +02:00
832bb01f36 Alerting: Add MQTT notifications receiver (#91487)
* Alerting: Add MQTT notifications receiver
* Update alerting to 9daa6239cc41dc42bff0e916c8d0d27766caa8b9 (main)
---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-08-22 16:47:48 +02:00
f833b782b6 Alerting docs: adds silence RBAC 11.1 (#89176)
* Alerting docs: adds silence RBAC 11.1

* ran prettier

* Improve docs with new rule-specific silence RBAC information

* Apply suggestions from code review

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Apply suggestions from code review

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* prettier

---------

Co-authored-by: Matt Jacobson <matthew.jacobson@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-06-27 10:10:34 +02:00
eb76ea47a0 Alerting: Add ha_reconnect_timeout configuration option (#88823)
* Docs: Update "Configure high availability" guide with ha_reconnect_timeout configuration

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2024-06-11 13:25:48 -04:00
3af72bdeee Alerting docs: fix Alertmanagers title (#88625) 2024-06-04 09:10:28 +02:00
68c44f1dd9 Alerting docs: Update Alertmanager docs (#88567)
* Remove alertmanager page and set redirects

* Update internal alertmanager links

* Update `Alertmanager` docs

* Change heading to `Configure Alertmanagers`
2024-06-03 11:00:52 +02:00
7a744a746b Alerting: Update docs with rule read RBAC changes (#88565)
* Remove ref to `datasources:query` for rule read

* Remove more refs to `datasources:query`

* Run prettier
2024-05-31 11:50:44 -04:00
26a01c42a6 Alerting docs: adds settings feature (#88294)
* Alerting docs: adds settings feature

* ran prettier
2024-05-24 15:01:15 +02:00
01d5744433 Alerting docs: adds note on provisioning to main page (#88264) 2024-05-24 09:44:21 +02:00
33db776c91 Alerting docs: fixes missing alt attributes (#88235)
* Fix missing `alt` text in images

* Fix `canonical` setting in AlertManager docs

* Fix `.`(dot) position in hyperlinks due to a temporary styling issue

* Revert "Fix `canonical` setting in AlertManager docs"

This reverts commit 65354b36422024e09709e5f5640d646b1cad75e0.
2024-05-23 18:07:52 +02:00
410e3b17e9 [docs/sources/alerting] Replace docs/reference shortcode with ref URIs (#88079) 2024-05-21 15:43:21 +03:00
f24eb3165b alerting: adding links to get-started tutorial (#87811)
* alerting: adding links to get-started tutorial

* Update index.md

* Update create-grafana-managed-rule.md

* Update _index.md

* Update _index.md

* Update docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/fundamentals/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* pretty

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-05-15 08:57:12 +02:00
7a2fbad0c8 Alerting: Add options to configure TLS for HA using Redis (#87567)
* Add Alerting HA Redis Client TLS configs

* Add test to ping miniredis with mTLS

* Update .ini files and docs

* Add tests for unified alerting ha redis TLS settings

* Fix malformed go.sum

* Add modowner

* Fix lint error

* Update docs and use dstls config
2024-05-14 14:21:42 +01:00
526be4fa2b Alerting vale fixes (#87380) 2024-05-06 11:43:34 +02:00
7077a5850e Alerting docs: more vale (#86978) 2024-04-27 09:59:42 +02:00
30d38c1775 Update the docs for state_periodic_save_interval (#86611)
This commit updates the docs for state_periodic_save_interval following
a question in the forums about what the consequences of this change could
be.
2024-04-22 11:13:02 +02:00
65e6b67b2e Embed creating alerts with Grafana video to the documentation (#86386) 2024-04-22 11:09:00 +02:00
b311612cf2 Alerting docs: RBAC for enterprise and cloud (#86506)
* Alerting docs: RBAC for enterprise and cloud

* rbac structure

* ran prettier

* updates to data source permissions

* adds tables for roles

* ran prettier

* adds examples for custom role

* ran prettier

* updates table

* typo fix

* ran prettier
2024-04-18 20:32:04 +02:00
1ffe858e06 chore: remove repetitive words (#86412)
Signed-off-by: TechVest <techdashen@qq.com>
2024-04-17 13:08:00 +01:00
0cb3e8bc49 Alerting docs: adds roles docs (#86261)
* Alerting docs: adds roles docs

* adds header

* adds link

* spacing

* prettier

* Update docs/sources/alerting/set-up/configure-roles/index.md

Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-roles/index.md

Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-roles/index.md

Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-roles/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/alerting/set-up/configure-roles/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/alerting/set-up/configure-roles/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/alerting/set-up/configure-roles/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/alerting/set-up/configure-roles/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* prettier

* Update docs/sources/alerting/set-up/configure-roles/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* corrects link

---------

Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-04-16 14:33:15 +02:00
0672bdf397 Alerting docs: add Template variable interpolation section in file provisioning (#84106)
* Alerting docs: add `Template variable interpolation` section in file provisioning

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>
2024-04-08 17:34:26 +02:00
d7ad7c6169 Alerting docs: update disable_provenance TF mute_timing (#85692) 2024-04-08 10:20:51 +02:00
a56a842d5f Alerting docs: fix docs/shared API to render the current version (#85526) 2024-04-03 16:04:58 +02:00
e138ae3eb9 Alerting: Improve openAPI specification and docs for export endpoints (#85008) 2024-03-22 18:25:27 +02:00
ec42b2a361 Alerting docs: restructure Introduction (#84248)
* Rename `Data sources` title

* Relocate and rename `Introduction/Notification templates`

* Rename `alert-rules/alert-instances` to `alert-rules/multi-dimensional-alerts`

* Move `fundamentals/high-availability` to `setup/enable-ha`

* Fix 404 high-availability alerting link on Setup HA Grafana docs

* Move alert manager/contact poitns/notification templates within Notifications

* Remove `Alerting on numeric data`

* Restructure Introduction v2

* Continue Intro restructuring

* Update docs/sources/alerting/fundamentals/alert-rules/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Complete contact point TODO

* Alias: alertManager

* Aliases `annotation-label` + content changes

* Aliases to `templating-labels-annotations`

* Aliases to `queries-conditions`

* Rename `rule-evaluation.md` file

* Aliases: `contact points`

* Aliases to `message-templating`

* Aliases to `alert-rules`

* Update links to new URL slugs

* Remove duplicated alias

* Remove trailing slash for external heading links

* Remove trailing slash in heading links to other grafana pages

* Change URL directory slug `fundamentals/notifications`

* rename title `Configure High Availability`

* Content changes

* Update docs/sources/alerting/fundamentals/alert-rules/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-alert-state-history/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-alert-state-history/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/fundamentals/alert-rules/_index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Fix broken link reference

* Fix `queries-and-conditions`

* Fix `alert-rule-evaluation` ref link

* Fix aliases + inline doc comments

* Fix broken link

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-03-14 16:58:18 +01:00
e1d9aa5a7b Alerting docs: document HTTP API to create templates (#84055) 2024-03-14 09:01:13 +01:00
e33e219a9a Remove legacy alerting docs (#84190) 2024-03-12 05:37:41 +01:00
dbb55f291a Alerting docs: update the supported export template functionality (#83816) 2024-03-07 08:42:38 +01:00
2653bd8fab Alerting docs: update file provisioning guide (#83924) 2024-03-06 09:18:59 +01:00
019c9618f0 Alerting docs: improve visibility on the distinct options to edit provisioned resources (#83839)
Alerting docs: specify the distinct options to edit provisioned resources
2024-03-05 10:48:04 +01:00
111df1bba0 Alerting docs: update the Terraform Provision guide (#83773)
* Alerting docs: update the Terraform Provision guide

* Fix incorrect links

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-03-04 12:10:37 +01:00
244589d7ea Alerting docs: document mute-timings export endpoints (#83797) 2024-03-04 10:50:44 +01:00
9eb69b9213 Alerting docs: fix incorrect docs/reference link (#83809) 2024-03-04 10:20:10 +01:00
88f010a72a Alerting docs: remove admonition/notes related to old Grafana versions (#83669) 2024-02-29 12:55:52 +01:00
2a429cd7db Fix typos (#83621)
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-29 10:47:22 +00:00
eb25b669c6 Alerting docs: update Alerting Provisioning (#83376)
* Minor updates to Provisioning Index page

* Add instructions to export other alerting resources

* Edit example provisioning a `template` via config file

* Add `Resource` column to the `Export API endpoints` table

* Sort the `export` endpoint on the table in `Alerting Provisioning HTTP API`

* Minor updates for clarity to `Use configuration files to provision` docs

* Add `More examples` in Terraform Provisioning docs

* File provisioning: rename `Useful Links` section to `More examples`

* Minor grammar change

* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Address requested changes to `Export` docs

* export: Minor grammar change

* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Fix `doc-validator` issue with relative link

* Use patch fixed version of doc-validator that better supports docs/reference destinations

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-27 16:22:24 +01:00
e564024883 Docs: change discussion link to issue link (#83434)
* change discussion link to issue link

* run prettier
2024-02-27 08:14:54 -06:00
9c42826c30 Alerting docs: fix broken link and apply the Writer toolkit guideline to other links (#83209)
* Fix `/docs/reference` cannot be used within admonitions

* Remove `relref` links to apply Writers toolkit guidelines
2024-02-22 11:31:59 +01:00
4720c99bd5 Alerting docs: Fix migrating alert links (#83141)
* Alerting docs: fixes migrating links

* Fixes underscores and stars

* Corrects numbering

* ran prettier

* Fix links

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/alerting/set-up/migrating-alerts/_index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-21 10:41:12 +01:00
b6098f2dde Alerting docs: clean up Cloud links (#83073)
* Use fixed `/docs/grafana-cloud/alerting-and-irm` URLs for cloud references

* Fix `docs/grafana-cloud/` data sources links

* Fix `docs/grafana-cloud/` Panel & Visualization links

* Fix `/docs/grafana-cloud/` link to Dashboard page

* Set root directory `docs/reference` for non-cloud pages

* Fix `admonition` cannot use a  `docs/reference` relative link

* Update `doc-validator`

https://github.com/grafana/technical-documentation/releases/tag/doc-validator%2Fv4.1.0

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-20 11:49:39 +01:00
118e4a50b7 Alerting: Remove start page of legacy upgrade preview (#82010)
Alerting: Remove start page of upgrade preview

Alerting upgrade page will now always show the summary table even before
upgrading any alerts or notification channels. There a few reasons for this:

- The information on the start page is redundant as it's now contained in the
documentation.
- Previously, if some unexpected issue prevented performing a full upgrade, a
user would have limited to no means to using the preview tool to help fix the
problem. This is because you could not see the summary table until the full
upgrade was performed at least once. Now, you can upgrade individual alerts and
notification channels from the beginning.
2024-02-15 17:34:00 -05:00
3909b4c14a Alerting docs: update <GRAFANA VERSION> to <GRAFANA_VERSION> (#82324) 2024-02-13 09:21:50 +00:00
9c92329bee Alerting docs: Provision alerting resources updates (#82221)
* Alert provisioning: initial restructuring

* Fix products labels

* Restructure `Import and export Grafana Alerting resources`

* Change URL to `export-alerting-resources`

* Complete `Export alerting resources`

* Export alerting resources

* Update `configuration files` provisioning

* Terraform Provisioning

* Change to `Provision/Import/Export` terms and some notes

* Replace `config` to `configuration`

* Set (menu)Title `Export alerting resources`

* Minor change on note about `Export Alerting endpoints`

* Fix `doc-validator` issues

* Fix grammar

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Fix numbered lists and `Note:` without admonition

* Convert text-based notes (`Note:`) to `admonition` blocks

* Replace text-based `Note:` with adminitions

* Remove `file-provisioning` grafana-cloud links

* Update `Export alerting resources` intro

* nitpicky format order

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-02-12 10:27:18 +01:00
ce57166c9a Alerting: GA alertingPreviewUpgrade and enable by default (#82038)
* Alerting: GA alertingPreviewUpgrade and enable by default
2024-02-08 18:59:25 +01:00
679d90be04 Patch 3 (#81937)
* Update _index.md

moved to the asked location

* ran prettier

* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-02-06 14:26:31 +01:00
95f90127ad Alerting docs: rename provisioning files (#81722) 2024-02-01 17:50:29 +01:00
da1538ba82 Alerting: Update docs after moving action buttons im the alert list, and move t… (#81375)
Update docs after moving action buttons im the alert list, and move the loading spinner
2024-01-29 16:52:34 +01:00
2e352ba4d6 Docs(alerting): Document the disable_provenance attribute (#81290)
We no longer need to pass a http header
2024-01-26 09:16:45 +01:00
25dd8d5ceb Docs: add section about periodic state saving for alerting (#81244) 2024-01-25 17:05:58 +01:00