Commit Graph

70 Commits

Author SHA1 Message Date
Ieva
2bc75016da
Docs: fix a typo (#89603)
Fix a typo
2024-06-24 10:27:48 +01:00
Jo
d972bdca08
Docs: Add fixed role UUIDs to docs for terraform provisioning (#89457)
* add role UUID to docs

* add table description and terraform hyperlink
2024-06-21 08:20:02 +00:00
Ieva
b2864d6dfb
Docs: add information about overrideRole provisioning option to docs (#89181)
add information about overrideRole provisioning option to docs
2024-06-14 13:16:16 +01:00
Ieva
10857c5400
Docs: Use bearer auth not basic auth in IAM doc examples (#88984)
use bearer auth not basic auth in examples
2024-06-11 10:35:22 +03:00
Ieva
e653003c73
Docs: Document the UIDs of basic roles (#88742)
document the UIDs of basic roles
2024-06-05 10:30:07 +03:00
Misi
eacf6e0a4d
Auth: Add org to role mappings support to GitHub integration (#88537)
* wip: add extra tests for verifying current logic

* Add OrgRole mapping and tests

* Update docs

* Clean up

* Update docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md

Co-authored-by: Mihai Doarna <mihai.doarna@grafana.com>

* Update docs with None role

* Apply suggestions from code review

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

* Fix

* Prettier docs

* Cleanup tests

---------

Co-authored-by: Mihai Doarna <mihai.doarna@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-06-03 14:24:58 +02:00
Larissa Wandzura
57038e8dfa
Docs: added note to RBAC doc from support escalation (#85311)
* added admonition and API info

* Update docs/sources/administration/roles-and-permissions/access-control/_index.md

---------

Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-05-06 09:27:46 +02:00
Eric Leijonmarck
f9714b9672
Docs: Update manage rbac w. toc and reference to provisioning w. file (#81120)
* docs: toc and reference to provisioning

* Update docs/sources/administration/roles-and-permissions/access-control/manage-rbac-roles/index.md

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

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-04-26 10:09:08 +01:00
Ieva
33e8292386
Docs: Clarify the docs for viewers_can_edit and editors_can_admin (#86422)
* clarify the docs for viewers_can_edit and editors_can_admin

* more changes

* more changes 2
2024-04-17 14:43:20 +01:00
Yuri Tseretyan
12605bfed2
Alerting: Update fixed roles to include silences permissions (#85826)
* update fixed roles to include silences
* add silence actions to managed permissions
* update documentation
2024-04-12 12:37:34 -04:00
Yuri Tseretyan
e167a435c8
Alerting: Add description of a new role (#85218) 2024-04-08 15:01:15 -04:00
Ieva
7aa0ba8c59
Teams: Display teams page to team reader if they also have the access to list team permissions (#84650)
* display teams to team reader if they also have the access to list team permissions

* fix a typo in the docs
2024-03-18 14:52:01 +02:00
Armand Grillet
e33e219a9a
Remove legacy alerting docs (#84190) 2024-03-12 05:37:41 +01:00
Isabel
0f47a6fa10
Docs: add RBAC for library panels (#82495)
* Added RBAC section to library panels page

* Added some library panel basic role and fixed role information

* Added remaining basic role information

* Added library panel fixed role permissions and descriptions

* Replaced 'general folder' with 'root level'

* Added library panel action definitions

* Added scope definitions

* Fixed fixed role information

* Added library panels to list of fixed roles

* Fixed typos

* Ran prettier

* Fixed links

* Fixed links again

* Updated link syntax
2024-02-15 10:29:33 -05:00
marybelvargas
fc498f5375
Update RBAC role name: fixed:datasources.id:reader (#82186) 2024-02-09 10:44:29 +00:00
Misi
e03a96d09b
Docs: Update default value of rbac.permission_validation_enabled (#82234)
* Update permission_validation_enabled default value in docs

* Lint
2024-02-09 11:14:56 +01:00
Joey Orlando
afc3380a38
update RBAC for OnCall documentation (#80828)
* update RBAC for OnCall documentation

* Update docs/sources/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/index.md

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

* fix typo

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-01-22 16:18:39 +00:00
João Calisto
65c3bb78a6
Feature Management: add documentation (#78108)
* Feature Management: add documentation

* lint docs

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md

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

* Update docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md

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

* Update docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md

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

* Update docs/sources/administration/feature-management/index.md

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update docs/sources/administration/feature-management/index.md

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* update docs

* lint

* revise docs

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Michael Mandrus <michael.mandrus@grafana.com>
2023-12-19 15:47:46 +00:00
Gabriel MABILLE
b6b86bb0b3
RBAC: Check plugins:install globally (#78438)
* RBAC: Check plugins:install globally

* Add disclamer to the RBACSingleOrganization config option
2023-11-21 15:09:43 +01:00
Ashley Harrison
9a905b6312
Navigation: Updates to the docs for admin subsections (#77500)
updates to the docs for admin subsections
2023-11-02 14:23:19 +00:00
Ieva
94fec65192
RBAC: introduce a data source admin role (#75915)
* introduce data source admin role and fix frontend check

* introduce fixed roles for data source creator and team reader

* add documentation

* undo an unintended change
2023-10-19 14:36:41 +01:00
Eric Leijonmarck
f10b4bc1da
Auth: None basic role update docs (#75955)
* docs: update basic role

* update docs

* Update docs/sources/administration/user-management/manage-org-users/index.md

Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>

* Update docs/sources/administration/roles-and-permissions/access-control/plan-rbac-rollout-strategy/index.md

Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>

---------

Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
2023-10-12 14:52:07 +03:00
Misi
e1aad9c9bf
Docs: Update RBAC documentation (#75869)
* Align docs to current permissions in code

* Update permissions list

* Add example responses, fix link

* Apply suggestions from code review

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

* Update based on reviews

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-10-04 17:53:26 +02:00
Jack Baldry
7255b97d73
Fix Grafana Enterprise link (#75623)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-28 13:03:23 +01:00
brendamuir
23a873b33f
Alerting docs: fixes next and latest link errors (#75437)
* Alerting docs: fixes next and latest link errors

* fixes bracket

* more link fixes

* fixes numbering

* prettier

* Fix build errors, a broken link, and use more appropriate destination for Grafana Cloud OnCall links

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

* fixes for jacks feedback

* fixes note

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-26 16:15:32 +02:00
linoman
5aacdd9f49
Docs: No basic role documentation updates (#75110)
* Add more scenarios to the documentation

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-09-20 15:23:16 +02:00
Yuri Tseretyan
6b4a9d73d7
Alerting: Export contact points to check access control action instead legacy role (#71990)
* introduce a new action "alert.provisioning.secrets:read" and role "fixed:alerting.provisioning.secrets:reader"
* update alerting API authorization layer to let the user read provisioning with the new action
* let new action use decrypt flag
* add action and role to docs
2023-08-08 19:29:34 +03:00
Jack Baldry
7eb17bccca
Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels

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

* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels

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

* Set administration/enterprise-licensing pages to have 'Enterprise' labels

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

* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels

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

* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels

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

* Set administration/recorded-queries pages to have labels cloud,enterprise

* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise

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

* Set administration/stats-and-license pages to have labels cloud,enterprise

* Set alerting pages to have labels cloud,enterprise,oss

* Set breaking-changes pages to have labels cloud,enterprise,oss

* Set dashboards pages to have labels cloud,enterprise,oss

* Set datasources pages to have labels cloud,enterprise,oss

* Set explore pages to have labels cloud,enterprise,oss

* Set fundamentals pages to have labels cloud,enterprise,oss

* Set introduction/grafana-cloud pages to have labels cloud

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

* Fix introduction pages products

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

* Set panels-visualizations pages to have labels cloud,enterprise,oss

* Set release-notes pages to have labels cloud,enterprise,oss

* Set search pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise

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

* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss

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

* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise

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

* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise

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

* Set troubleshooting pages to have labels cloud,enterprise,oss

* Set whatsnew pages to have labels cloud,enterprise,oss

* Apply updated labels from review

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 09:10:12 +01:00
brendamuir
5159317ee7
Docs: adds evaluation doc (#70757)
* Docs: adds evaluation doc

* Adds note on classic condition

* fixes link

* fixes link

* fixes link

* fixes data source

* link fix

* fixes rbac link

* adds aliases
2023-06-28 10:38:59 +02:00
Eve Meelan
6edd2e7296
Everything in Cloud free updates (#69948)
* updates for everything in Free

* more cloud free
2023-06-12 11:14:02 -07:00
Vardan Torosyan
8235f774aa
Docs: Rename External Group Sync references to Team Sync (#69395) 2023-06-01 10:48:32 -05:00
Jack Baldry
f29b058927
Update cascading front matter to use sequence form (#67094)
* Update cascading front matter to use sequence form

The map form does not override the sequence form that is used in the website repository to specify the default labels.
For more information, refer to https://github.com/grafana/writers-toolkit/pull/234.

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

* Remove useless alias

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

* Update labels for pages noted in code review

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

* Move all product labeling to the project index file

All changes can be made in a single place.

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

* Move all individual page product labels to project index file

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

* Shorten YAML

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

* Add newlines to aid readability

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

* Document front matter ordering

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

* Rewrite labels for breaking-changes pages

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

* updated labels for whats new and breaking changes

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-05-31 16:52:03 +01:00
Matt Dodson
1c4bb9ca00
[feat] docs; update admonition syntax (#68842)
* [feat] docs; update admonition syntax

- Standardizes according to style conventions: https://grafana.com/docs/writers-toolkit/style-guide/style-conventions/#admonitions
- Prepares docs for better, uniform admonition style.

* Remove false positives and irregularities

* false positive removal

* Update docs/sources/datasources/mysql/_index.md

* Update docs/sources/developers/angular_deprecation/angular-plugins.md

* fix link errors

* Prettify some nested blockquotes

* remoe unnecessary admonition
2023-05-22 15:45:28 -05:00
Alexander Zobnin
1d99500b3e
SAML UI: Fix permissions for fixed:authentication.config:writer role (#67290)
* SAML UI: Fix permissions for fixed:authentication.config:writer role

* Remove read permissions for auth settings
2023-04-27 15:46:47 +02:00
Ieva
c962d3175b
Docs: troubleshooting guide for RBAC (#67147)
* docs on how to reset permissions

* remove unneeded cascade
2023-04-26 11:49:29 +01:00
Ieva
9a29dd7d6e
Docs: Documentation updates for nested folder permissions (#66599)
doc updates for nested folder permissions
2023-04-21 06:29:52 -04:00
Ieva
9271583091
Docs: Add definition for auth config writer role (#66957)
add definition for auth writer role
2023-04-21 10:40:46 +01:00
Ezequiel Victorero
772d00b28f
PublicDashboards: RBAC update docs (#66529) 2023-04-19 12:32:44 -03:00
Jack Baldry
dec3361331
Remove "Open source" label from all "RBAC" pages (#66129)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-04-11 09:32:54 +01:00
Ieva
80444d60f9
Docs: define RBAC n/a for a scope (#65782)
* define n/a scope

* Update docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

* linting

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-04-04 14:22:02 +01:00
Isabel
c94760e844
docs: nav updates for administration & licensing (#65400)
* navigation related updates text only

* fixed styling
2023-03-27 13:04:27 -07:00
Isabel
0efa8c5ce1
docs: nav updates for user, role, team management (#64965)
* text nav updates

* navigation related updates

* used Connections instead of Administration workflow for add data source steps

* wording edit

* updated data source permissions section

* Apply suggestions from code review and wording edit

* empty commit to trigger linting

* change to trigger linting
2023-03-21 10:45:50 -07:00
Christopher Moyer
cf272186fb
Docs: corrects typo (#62954)
corrects typo
2023-02-06 09:35:13 -06:00
Ieva
9a8c798bae
Docs: add missing plugin roles, actions and scope (#61182)
* add missing plugin roles, actions and scope

* Update docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md

Co-authored-by: Alyssa Wada <101596687+alyssawada@users.noreply.github.com>

* Update docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md

Co-authored-by: Gabriel MABILLE <gamab@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Gabriel MABILLE <gamab@users.noreply.github.com>

Co-authored-by: Alyssa Wada <101596687+alyssawada@users.noreply.github.com>
Co-authored-by: Gabriel MABILLE <gamab@users.noreply.github.com>
2023-01-17 10:03:31 +00:00
Ieva
bc75ee1392
Docs: OnCall role and action definitions (#61175)
* OnCall role and action definitions

* change verbs from write to update or edit

* Update docs/sources/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/index.md

Co-authored-by: Joey Orlando <joseph.t.orlando@gmail.com>
2023-01-12 08:40:19 -06:00
Christopher Moyer
3d8890453f
docs: corrects broken links (#60594)
correct broken links
2022-12-21 08:44:23 +00:00
Christopher Moyer
b5834fd6d3
docs: fixes links (#60541)
fixes links
2022-12-20 08:18:56 -06:00
Jack Baldry
c1c48dd610
Use relative aliases for all non-current Grafana aliases (#60062)
* Use relative aliases for all non-current Grafana aliases

Prevents non-latest documentation "stealing" the page away from latest
and through permanent redirects for latest pages that no longer exist.

The redirected pages are indexed by search engines but our robots.txt
forbids them crawling the non-latest page.

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

* Remove aliases from shared pages

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

* Rewrite all current latest aliases to be next

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

* Fix typo in latest alias

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

* Remove all current page aliases

find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/next/[^\n]*\n#\n#' {} \;
find docs/sources -type f -name '*.md' -exec sed -Ez -i 's#\n((aliases:\n *-)|aliases:\n)#\n\2#' {} \;

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

* Prettier

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

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-12-09 12:36:04 -04:00
Christopher Moyer
5240905f05
docs: fixes broken link and spelling error (#59828)
fixes broken link and spelling error
2022-12-05 10:00:20 -06:00
Gabriel MABILLE
8e929163a8
RBAC: Add config option to reset basic roles on start up (#59598)
* RBAC: add config option to reset basic roles on start up

Co-authored-by: Jguer <joao.guerreiro@grafana.com>

* Update docs

Co-authored-by: Jguer <joao.guerreiro@grafana.com>

* Add to sample.ini as well

Co-authored-by: Jguer <joao.guerreiro@grafana.com>

Co-authored-by: Jguer <joao.guerreiro@grafana.com>
2022-12-01 09:41:40 +01:00