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

Add notes to selfAuth with Azure docs #4835

Merged

Conversation

davidmirror-ops
Copy link
Contributor

@davidmirror-ops davidmirror-ops commented Feb 5, 2024

Why are the changes needed?

From recent interactions with Flyte deployments with Azure as IdP, some precisions are needed in the selfAuth docs.

What changes were proposed in this pull request?

How was this patch tested?

Setup process

Screenshots

Check all the applicable boxes

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

Related PRs

Docs link

Signed-off-by: davidmirror-ops <david [email protected]>
@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. documentation Improvements or additions to documentation labels Feb 5, 2024
@davidmirror-ops davidmirror-ops changed the title Add notes from to selfAuth with Azure docs Add notes to selfAuth with Azure docs Feb 5, 2024
Copy link

codecov bot commented Feb 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1bbe867) 58.98% compared to head (80ba0f1) 59.68%.
Report is 11 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4835      +/-   ##
==========================================
+ Coverage   58.98%   59.68%   +0.70%     
==========================================
  Files         567      645      +78     
  Lines       44496    49534    +5038     
==========================================
+ Hits        26244    29563    +3319     
- Misses      15858    17396    +1538     
- Partials     2394     2575     +181     
Flag Coverage Δ
unittests 59.34% <ø> (+1.98%) ⬆️

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.


11. Restart ``flytescheduler``` to start using authenticated requests:
10. Verify that the `flytepropeller`, `flytescheduler` and `flyteadmin` Pods are restarted and Running:
Copy link
Contributor

Choose a reason for hiding this comment

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

What's the reason to remove the instructions on how to restart the deployments (kubectl rollout restart ...) in the docs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because once the Helm release is upgraded, it triggers redeployment of those services

neverett
neverett previously approved these changes Feb 7, 2024
Copy link
Contributor

@neverett neverett left a comment

Choose a reason for hiding this comment

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

I left a few small suggestions, but otherwise LGTM!


.. prompt:: bash $
For `multi-cluster deployments <https://docs.flyte.org/en/latest/deployment/deployment/multicluster.html>`__, this secret definition has to be added to the `values-dataplane.yaml` file.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For `multi-cluster deployments <https://docs.flyte.org/en/latest/deployment/deployment/multicluster.html>`__, this secret definition has to be added to the `values-dataplane.yaml` file.
For `multi-cluster deployments <https://docs.flyte.org/en/latest/deployment/deployment/multicluster.html>`__ running `flytepropeller` in the control plane cluster, you must add this secret definition to the `values-dataplane.yaml` file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm trying not to get lost in grammar :) The idea is: in every cluster where propeller is running you need that secret (not only environments where propeller is running on the control plane cluster).
Propeller in the control plane cluster is optional, for the data plane is a must.

Let me know if it's clear or not

Copy link
Contributor

Choose a reason for hiding this comment

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

Gotcha, then I would suggest:

For `multi-cluster deployments <https://docs.flyte.org/en/latest/deployment/deployment/multicluster.html>`__, you must add this secret definition to the `values-dataplane.yaml` file.


.. prompt:: bash $
For `multi-cluster deployments <https://docs.flyte.org/en/latest/deployment/deployment/multicluster.html>`__, this secret definition has to be added to the `values-dataplane.yaml` file.
There's no need to create this secret in the control plane cluster if you're not running `flytepropeller` there.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
There's no need to create this secret in the control plane cluster if you're not running `flytepropeller` there.
If you are not running `flytepropeller` in the control plane cluster, you do not need to create this secret there.

docs/deployment/configuration/auth_setup.rst Outdated Show resolved Hide resolved
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Feb 7, 2024
Signed-off-by: davidmirror-ops <david [email protected]>
Signed-off-by: davidmirror-ops <david [email protected]>
@davidmirror-ops davidmirror-ops merged commit 03a0aef into flyteorg:master Feb 9, 2024
48 of 49 checks passed
katrogan pushed a commit that referenced this pull request Feb 20, 2024
* Add notes from recent Azure deployments

Signed-off-by: davidmirror-ops <david [email protected]>

* Rephrase multicluster auth

Signed-off-by: davidmirror-ops <david [email protected]>

* Rephrase multicluster auth v2

Signed-off-by: davidmirror-ops <david [email protected]>

---------

Signed-off-by: davidmirror-ops <david [email protected]>
Co-authored-by: davidmirror-ops <david [email protected]>
Signed-off-by: Katrina Rogan <[email protected]>
yubofredwang pushed a commit to yubofredwang/flyte that referenced this pull request Mar 26, 2024
* Add notes from recent Azure deployments

Signed-off-by: davidmirror-ops <david [email protected]>

* Rephrase multicluster auth

Signed-off-by: davidmirror-ops <david [email protected]>

* Rephrase multicluster auth v2

Signed-off-by: davidmirror-ops <david [email protected]>

---------

Signed-off-by: davidmirror-ops <david [email protected]>
Co-authored-by: davidmirror-ops <david [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:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants