sample.yaml 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. # ---
  2. # # config file version
  3. # apiVersion: 2
  4. # # <list> list of roles to insert/update/delete
  5. # roles:
  6. # # <string, required> name of the role you want to create or update. Required.
  7. # - name: 'custom:users:writer'
  8. # # <string> uid of the role. Has to be unique for all orgs.
  9. # uid: customuserswriter1
  10. # # <string> description of the role, informative purpose only.
  11. # description: 'Create, read, write users'
  12. # # <int> version of the role, Grafana will update the role when increased.
  13. # version: 2
  14. # # <int> org id. Defaults to Grafana's default if not specified.
  15. # orgId: 1
  16. # # <list> list of the permissions granted by this role.
  17. # permissions:
  18. # # <string, required> action allowed.
  19. # - action: 'users:read'
  20. # #<string> scope it applies to.
  21. # scope: 'users:*'
  22. # - action: 'users:write'
  23. # scope: 'users:*'
  24. # - action: 'users:create'
  25. # - name: 'custom:global:users:reader'
  26. # # <bool> overwrite org id and creates a global role.
  27. # global: true
  28. # # <string> state of the role. Defaults to 'present'. If 'absent', role will be deleted.
  29. # state: 'absent'
  30. # # <bool> force deletion revoking all grants of the role.
  31. # force: true
  32. # - uid: 'basic_editor'
  33. # version: 2
  34. # global: true
  35. # # <list> list of roles to copy permissions from.
  36. # from:
  37. # - uid: 'basic_editor'
  38. # global: true
  39. # - name: 'fixed:users:writer'
  40. # global: true
  41. # # <list> list of the permissions to add/remove on top of the copied ones.
  42. # permissions:
  43. # - action: 'users:read'
  44. # scope: 'users:*'
  45. # - action: 'users:write'
  46. # scope: 'users:*'
  47. # # <string> state of the permission. Defaults to 'present'. If 'absent', the permission will be removed.
  48. # state: absent
  49. # # <list> list role assignments to teams to create or remove.
  50. # teams:
  51. # # <string, required> name of the team you want to assign roles to. Required.
  52. # - name: 'Users writers'
  53. # # <int> org id. Will default to Grafana's default if not specified.
  54. # orgId: 1
  55. # # <list> list of roles to assign to the team
  56. # roles:
  57. # # <string> uid of the role you want to assign to the team.
  58. # - uid: 'customuserswriter1'
  59. # # <int> org id. Will default to Grafana's default if not specified.
  60. # orgId: 1
  61. # # <string> name of the role you want to assign to the team.
  62. # - name: 'fixed:users:writer'
  63. # # <bool> overwrite org id to specify the role is global.
  64. # global: true
  65. # # <string> state of the assignment. Defaults to 'present'. If 'absent', the assignment will be revoked.
  66. # state: absent