Add allowedAudience to flyte-core external auth deployment documentation #5124
Conversation
Signed-off-by: Mark Waylonis <[email protected]>
|
Thank you for opening this pull request! 🙌 These tips will help get your PR across the finish line:
|
dosubot
bot
added
size:XS
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5124 +/- ##
==========================================
- Coverage 59.00% 58.99% -0.02%
==========================================
Files 645 645
Lines 55672 55672
==========================================
- Hits 32850 32844 -6
- Misses 20226 20232 +6
Partials 2596 2596
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
| @@ -564,6 +564,8 @@ Follow the steps in this section to configure `flyteadmin` to use an external au | |||
|
|
|||
| # 2. Optional: Set external auth server baseUrl if different from OpenId baseUrl. | |||
| externalAuthServer: | |||
| # Replace this with your deployment URL. It will be used by flyteadmin to validate the token audience | |||
| allowedAudience: [https://<your-flyte-deployment-URL>] | |||
There was a problem hiding this comment.
since this is an array, in order to decrease the risk of confusion with the square brackets (e.g. should I include them or not?), can you put this in a separate line?
There was a problem hiding this comment.
do you mean something like this?:
allowedAudience: [
https://<your-flyte-deployment-URL>
]
There was a problem hiding this comment.
@eapolinario or maybe just removing the brackets altogether?
Why are the changes needed?
This adds documentation to the auth config for flyte-core deployments with Okta. In the case where flyteadmin is running in the same cluster as flytepropeller/flytescheduler, the authentication request from flytescheduler to flyteadmin is made using
http://flyteadmin:80. flyteadmin uses the domain in the request to validate the audience in the JWT returned by okta (code reference). This causes a mismatch between the JWT audience and the expectedAudience when the auth request originates from flytescheduler within the same cluster. TheallowedAudiencesetting takes precedence over the URL extracted from the request, so setting this property in the values file fixes the issue.What changes were proposed in this pull request?
This is only a documentation change
How was this patch tested?
Tested with the latest helm chart
Check all the applicable boxes
Docs link