Skip to content

website/integrations: Add custom Group/Role mapping documentation for Grafana#7453

Merged
BeryJu merged 4 commits intogoauthentik:mainfrom
gmemstr:main
Dec 30, 2023
Merged

website/integrations: Add custom Group/Role mapping documentation for Grafana#7453
BeryJu merged 4 commits intogoauthentik:mainfrom
gmemstr:main

Conversation

@gmemstr
Copy link
Copy Markdown
Contributor

@gmemstr gmemstr commented Nov 6, 2023

Details

Adds some more documentation around assigning roles in Grafana from Authentik groups. Grafana will use the profile scope's groups entry to map to its own Groups concept (from what I can tell), so we need to nest the groups somewhere Grafana won't automatically pick up so they can be assigned.

Checklist

  • Local tests pass (ak test authentik/)
  • The code has been formatted (make lint-fix)

If an API change has been made

  • The API schema has been updated (make gen-build)

If changes to the frontend have been made

  • The code has been formatted (make web)
  • The translation files have been updated (make i18n-extract)

If applicable

  • The documentation has been updated
  • The documentation has been formatted (make website)

@gmemstr gmemstr requested a review from a team as a code owner November 6, 2023 12:03
@netlify
Copy link
Copy Markdown

netlify bot commented Nov 6, 2023 •
edited
Loading

✅ Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit 0d9febc
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/654e496846d7f3000888f603
😎 Deploy Preview https://deploy-preview-7453--authentik-storybook.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@netlify
Copy link
Copy Markdown

netlify bot commented Nov 6, 2023 •
edited
Loading

✅ Deploy Preview for authentik ready!

Name Link
🔨 Latest commit 0d9febc
🔍 Latest deploy log https://app.netlify.com/sites/authentik/deploys/654e49685939f40008b9f878
😎 Deploy Preview https://deploy-preview-7453--authentik.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 96 (🔴 down 1 from production)
Accessibility: 90 (no change from production)
Best Practices: 100 (no change from production)
SEO: 80 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@tanberry
Copy link
Copy Markdown
Contributor

tanberry commented Nov 10, 2023

Thanks so much @gmemstr for the addition to the Grafana integration docs! We will get a tech review done and merge your PR as soon as possible. We appreciate you!

tanberry
tanberry requested changes Nov 10, 2023
View reviewed changes
@gmemstr @tanberry
Update website/integrations/services/grafana/index.mdx
0d9febc 
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Gabriel Simmer <github@gmem.ca>
@codecov
Copy link
Copy Markdown

codecov bot commented Nov 10, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c897271) 92.59% compared to head (0d9febc) 90.98%.
Report is 50 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #7453      +/-   ##
==========================================
- Coverage   92.59%   90.98%   -1.61%     
==========================================
  Files         587      587              
  Lines       28898    28989      +91     
==========================================
- Hits        26757    26376     -381     
- Misses       2141     2613     +472
Flag Coverage Δ
e2e 49.49% <ø> (-1.46%) ⬇️
integration ?
unit 89.62% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 30 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

BeryJu
BeryJu reviewed Nov 10, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@BeryJu BeryJu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi! The default profile mapping already returns the groups which is what the current configuration use, so this shouldn't be required. Did the default configuration not work for you?

@gmemstr
Copy link
Copy Markdown
Contributor Author

gmemstr commented Nov 10, 2023

@BeryJu As noted in the PR, it does not - the groups entry is taken by Grafana (my assumption is that it's trying to be used for Grafana's own groups, which don't map to authentik groups) and is blank by the time it's being used for role assignment, hence the nesting it in info.

@kissi7
Copy link
Copy Markdown

kissi7 commented Nov 30, 2023

@BeryJu As noted in the PR, it does not - the groups entry is taken by Grafana (my assumption is that it's trying to be used for Grafana's own groups, which don't map to authentik groups) and is blank by the time it's being used for role assignment, hence the nesting it in info.

Hi, I can confirm that groups are propagated to grafana, but are not used to map user to role for some reason.
With proposed PR it is working just fine. Thank you very much.

@BeryJu BeryJu changed the title Add custom Group/Role mapping documentation for Grafana website/integrations: Add custom Group/Role mapping documentation for Grafana Dec 30, 2023
@BeryJu BeryJu merged commit 255f217 into goauthentik:main Dec 30, 2023
kensternberg-authentik added a commit that referenced this pull request Jan 2, 2024
@kensternberg-authentik
Merge branch 'main' into web/issue-4880-multi-select-limitations
73bba04 
* main: (30 commits)
  outposts/proxy: better Redis error message (#8044)
  translate: Updates for file web/xliff/en.xlf in fr (#8046)
  web: bump the eslint group in /tests/wdio with 2 updates (#8041)
  web: bump the storybook group in /web with 7 updates (#8042)
  web: bump the eslint group in /web with 2 updates (#8043)
  web: bump @types/guacamole-common-js from 1.3.2 to 1.5.2 in /web (#8030)
  translate: Updates for file web/xliff/en.xlf in zh_CN (#8038)
  translate: Updates for file web/xliff/en.xlf in zh-Hans (#8039)
  website: bump clsx from 2.0.0 to 2.1.0 in /website (#8033)
  core: bump golang from 1.21.3-bookworm to 1.21.5-bookworm (#8027)
  web: bump the babel group in /web with 4 updates (#8028)
  web: bump the esbuild group in /web with 2 updates (#8029)
  web: bump rollup from 4.9.1 to 4.9.2 in /web (#8031)
  tests/e2e: fix tests to work without docker network_mode host (#8035)
  website/docs: fix typo (#8015)
  web: bump API Client version (#8025)
  enterprise/providers: Add RAC [AUTH-15] (#7291)
  outposts: disable deployment and secret reconciler for embedded outpost in code instead of in config (#8021)
  providers/proxy: use access token (#8022)
  website/integrations: Add custom Group/Role mapping documentation for Grafana (#7453)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@BeryJu BeryJu BeryJu left review comments

@tanberry tanberry tanberry requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@gmemstr @tanberry @kissi7 @BeryJu