Skip to content

website/integrations: add Chronograf#7766

Closed
tomlawesome wants to merge 2 commits intogoauthentik:mainfrom
tomlawesome:main
Closed

website/integrations: add Chronograf#7766
tomlawesome wants to merge 2 commits intogoauthentik:mainfrom
tomlawesome:main

Conversation

@tomlawesome
Copy link

Add Chronograf oauth integration to website.

Details

Chronograf is not listed yet in integrations, but it's working well for me using their generic oauth and Authentik's oauth endpoints generated by simply creating an oauth provider.


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)

Add Chronograf oauth integration to website.

Signed-off-by: tomlawesome <76453276+tomlawesome@users.noreply.github.com>
@tomlawesome tomlawesome requested a review from a team as a code owner December 3, 2023 19:53
@netlify
Copy link

netlify bot commented Dec 3, 2023

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit 8ac6761
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/657476f53f0b6200080ad881
😎 Deploy Preview https://deploy-preview-7766--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

netlify bot commented Dec 3, 2023

Deploy Preview for authentik ready!

Name Link
🔨 Latest commit 8ac6761
🔍 Latest deploy log https://app.netlify.com/sites/authentik/deploys/657476f5cf227400082995a3
😎 Deploy Preview https://deploy-preview-7766--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: 97 (no change 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.

@rissson rissson changed the title Add Chronograf to website website/integrations: add Chronograf Dec 4, 2023
@tanberry
Copy link
Contributor

tanberry commented Dec 4, 2023

Thanks so much @tomlawesome for this contribution! I'll do a copy-edit on the docs, and get a tech review on it. Always nice to add more integrations.

@tanberry tanberry requested a review from rissson December 4, 2023 16:02
```
In this configuration, "GENERIC_NAME" is what will appear on the Chronograf login page:

![image](https://github.com/tomlawesome/authentik/assets/76453276/c14a4694-563b-4a94-9cd4-162c4e543bd7)
Copy link
Member

Choose a reason for hiding this comment

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

Can we put this asset directly in this repository?

Copy link
Author

Choose a reason for hiding this comment

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

I'm not sure, sorry. Very new to pull requests!

Copy link
Member

Choose a reason for hiding this comment

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

Sure, no worries. What you can do is directly put the image under website/integrations/services/chronograf/login.png and use ![](./login.png) to show the image.

Co-authored-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Signed-off-by: tomlawesome <76453276+tomlawesome@users.noreply.github.com>
Copy link
Member

@rissson rissson left a comment

Choose a reason for hiding this comment

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

I missed it before, but you also need to add this page to website/sidebarsIntegrations.js, probably under the Monitoring category (the list is alphabetically sorted).

```
In this configuration, "GENERIC_NAME" is what will appear on the Chronograf login page:

![image](https://github.com/tomlawesome/authentik/assets/76453276/c14a4694-563b-4a94-9cd4-162c4e543bd7)
Copy link
Member

Choose a reason for hiding this comment

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

Sure, no worries. What you can do is directly put the image under website/integrations/services/chronograf/login.png and use ![](./login.png) to show the image.

@codecov
Copy link

codecov bot commented Dec 11, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.63%. Comparing base (6bdbdaf) to head (8ac6761).
Report is 2994 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7766      +/-   ##
==========================================
- Coverage   92.64%   92.63%   -0.01%     
==========================================
  Files         588      588              
  Lines       29141    29200      +59     
==========================================
+ Hits        26997    27049      +52     
- Misses       2144     2151       +7     
Flag Coverage Δ
e2e 50.65% <ø> (-0.07%) ⬇️
integration 25.91% <ø> (-0.04%) ⬇️
unit 89.70% <ø> (-0.02%) ⬇️

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

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

@PierreBtz
Copy link

Hey, thanks a lot for this PR, this helped a lot.

However I had to add USE_ID_TOKEN=true for the setup to properly work (as per https://docs.influxdata.com/chronograf/v1/administration/managing-security/#jwks-signature-verification-optional).

@tanberry
Copy link
Contributor

Hi @tomlawesome can you take a look at the last few points/edits, and then see about adding the tip that @PierreBtz made? Also, you'll need to run make website or make website-lint-fix before pushing your final commit, so that the build check for linting passes.

Apologies we let this one sit for a bot; we are looking forward to your reply and getting it merged, thanks!

tanberry pushed a commit that referenced this pull request Dec 30, 2024
* website/integrations: chronograf: init

Adds the version proposed in https://github.com/goauthentik/authentik/blob/8ac6761920bab879b03b2b5ce3b9da3075f95953/website/integrations/services/chronograf/index.md .

Signed-off-by: 4d62 <github-user@sdko.org>

* website/integrations: chronograf: start cleanup

Adds a `sidebar_label`, updates the start of the documentation to the follow the template, and updates `service.company` to `chronograf.company` in the preparation documentation.

Signed-off-by: 4d62 <github-user@sdko.org>

* website/integrations: chronograf: add to sidebar

Adds the integration to the `sidebarsIntegration.js` file.

Signed-off-by: 4d62 <github-user@sdko.org>

* website/integrations: chronograf: main body

Rewrite most of the documentation, cleanup unneeded bits, and update format.

Signed-off-by: 4d62 <github-user@sdko.org>

* website/integrations: chronograf: finishing touches

This PR is now ready for review. Cleans up sentence structure, grammar, and visual stuff.

Signed-off-by: 4d62 <github-user@sdko.org>

* website/integrations: chronograf: lint

Links modified file with prettier.

Signed-off-by: 4d62 <github-user@sdko.org>

* website/integrations: chronograf: add `USE_ID_TOKEN=true`

Adds `USE_ID_TOKEN=true` to the list of needed environment following this comment in the initial merge request:  #7766 (comment)

Signed-off-by: 4d62 <github-user@sdko.org>

* website/integrations: chronograf: apply review suggestions

Applies suggestions from the first review round

---------

Signed-off-by: 4d62 <github-user@sdko.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants