Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add missing key in auth guide #5169

Merged

Conversation

Jeinhaus
Copy link
Contributor

@Jeinhaus Jeinhaus commented Apr 3, 2024

Why are the changes needed?

The authentication and authorization guides for flyte-core are slightly wrong and led to some confusion on our side.

What changes were proposed in this pull request?

This PR should fix missing keys and improve some formatting for the AzureAD guide.

Docs link

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Apr 3, 2024
@Jeinhaus Jeinhaus force-pushed the docs/add-missing-key-in-auth-guid branch from 33b5eac to d353c64 Compare April 3, 2024 09:27
Copy link
Contributor

@davidmirror-ops davidmirror-ops left a comment

Choose a reason for hiding this comment

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

Thank you!
Anything else in particular to Keycloak that's missing/incorrect in the docs?

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Apr 3, 2024
Copy link

codecov bot commented Apr 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.11%. Comparing base (dc1294e) to head (d353c64).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5169   +/-   ##
=======================================
  Coverage   59.11%   59.11%           
=======================================
  Files         645      645           
  Lines       55574    55574           
=======================================
  Hits        32852    32852           
  Misses      20129    20129           
  Partials     2593     2593           
Flag Coverage Δ
unittests 59.11% <ø> (ø)

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.

@Jeinhaus
Copy link
Contributor Author

Jeinhaus commented Apr 4, 2024

Thank you! Anything else in particular to Keycloak that's missing/incorrect in the docs?

For the authentication setup the guide was ok I think. But I still haven't gotten authorization working with Keycloak. For now, we used the internal authorization server. So I'm pretty sure there are parts missing, but I can't tell you what since I haven't figured it out 🙈 .

@davidmirror-ops davidmirror-ops merged commit e8a44b4 into flyteorg:master Apr 4, 2024
48 checks passed
Copy link

welcome bot commented Apr 4, 2024

Congrats on merging your first pull request! 🎉

@Jeinhaus Jeinhaus deleted the docs/add-missing-key-in-auth-guid branch April 5, 2024 05:26
Jeinhaus added a commit to Jeinhaus/flyte that referenced this pull request Apr 8, 2024
* docs(flyte-core): add missing key `adminServer` in authentication guide

Signed-off-by: Julian Einhaus <[email protected]>

* docs(flyte-core): fix indentation for flyte-core with AzureAD authorization guide

Signed-off-by: Julian Einhaus <[email protected]>

---------

Signed-off-by: Julian Einhaus <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants