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] Update auth_setup.rst #5863

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

pranshustuff
Copy link

@pranshustuff pranshustuff commented Oct 18, 2024

Tracking issue

Closes #5552

Why are the changes needed?

The docs had a few issues as mentioned in the issue and the intro was slightly hard to read and understand.

What changes were proposed in this pull request?

  1. The steps for MS Entra ID tab in Identity Management layer : OIDC were updated and formatted in detail, to keep up with Azure UI changes.
  2. The indentation for configmap.adminServer.security was corrected.
  3. Steps 8 onward were taken out of the Notes block.
  4. The introduction to Identity server and authorization server was formatted for better readability.

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Docs link

Authenticating in Flyte page, changes mentioned above

Fixed the following issues:
1. The steps for MS Entra ID have to be updated to reflect the current location of settings on the Azure UI
2. fixed indentation error in ``configmap.adminServer.security``
3. Step 8 and beyond are folded inside the Note block when it should be out.
4. made the intro slightly easier to read.


Signed-off-by: Pranshu <[email protected]>
@pranshustuff pranshustuff changed the title Update auth_setup.rst [Docs] Update auth_setup.rst Oct 19, 2024
Copy link

codecov bot commented Nov 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.72%. Comparing base (38af4ec) to head (b6e6eab).
Report is 35 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5863   +/-   ##
=======================================
  Coverage   36.72%   36.72%           
=======================================
  Files        1304     1304           
  Lines      130072   130072           
=======================================
  Hits        47764    47764           
  Misses      78138    78138           
  Partials     4170     4170           
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.43% <ø> (ø)
unittests-flytecopilot 11.73% <ø> (ø)
unittests-flytectl 62.40% <ø> (ø)
unittests-flyteidl 6.89% <ø> (ø)
unittests-flyteplugins 53.62% <ø> (ø)
unittests-flytepropeller 42.84% <ø> (ø)
unittests-flytestdlib 54.78% <ø> (ø)

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.

As defined by IETF's `RFC #6749 <https://datatracker.ietf.org/doc/html/rfc6749>`__, the authorization server's role is to issue *access tokens to the client after successfully authenticating the resource owner and obtaining authorization*. In this context, the *resource owner* is the end user of Flyte; and the *client* is the tool or component that intends to interact with ``flyteadmin`` : ``flytepropeller``, ``flyteconsole`` or any of the CLI tools.
As defined by IETF's `RFC #6749 <https://datatracker.ietf.org/doc/html/rfc6749>`__ , the authorization server’s job is to issue access tokens to clients after verifying the user (resource owner) and getting their consent. In this setup:

1. The user of Flyte, is the *resource owner*.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if we'll have to remove indentation here unless the intent for this to render like:

image

Copy link
Author

Choose a reason for hiding this comment

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

I tried it without indentation but then the whole authorization server paragraph becomes italics for some reason. If you can suggest a fix for that please do.

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.

[Docs] auth setup page issues
2 participants