Create auth manager documentation#36211
Conversation
| specific language governing permissions and limitations | ||
| under the License. | ||
|
|
||
| API Authentication |
There was a problem hiding this comment.
This section has been moved from security/api.rst
| specific language governing permissions and limitations | ||
| under the License. | ||
|
|
||
| Webserver authentication |
There was a problem hiding this comment.
This section has been moved from security/webserver.rst
Co-authored-by: Niko Oliveira <onikolas@amazon.com>
Co-authored-by: Niko Oliveira <onikolas@amazon.com>
Co-authored-by: Niko Oliveira <onikolas@amazon.com>
Co-authored-by: Niko Oliveira <onikolas@amazon.com>
|
Comment/ Proposal. Why don't you prepare one/two diagrams, similar to the ones that you had in the AIP. I recently integrated the nice Python "Diagram as a Code" tool into our pre-commit workflows - and it should be very simple to add new diagrams (I plan to have it more distributed, in a near future and have separate python script for each diagram - next to the diagram it creates, but for now it would be easy to add one more diagram to generate to this pre-commit: It's super-easy to create diagrams in it -very similar concept as Airflow DAGs in fact :) |
Sounds exciting! Let me try that |
Indeed, I love how they implemented it and it's really nice to iterate on diagram, it's super-fast- just change the code, run the pre-commit and the image gets regenerated :). You could actually make auto-action on save with it to get it nearly-live-update. |
|
BTW. You can run the pre-comit script "as-is" - as long as you have diagrams installed in your venv it works as regular Python script |
This reverts commit 99adb0a.
|
In the meantime, do you know why it is complaining about |
|
Sphinx speaking riddles again I will take a look after my talk (I have a talk at https://osacon.io in 45 minutes so a little stressed ;) . |
Thank you :D! And good luck for your talk |
|
Creating diagrams is actually super fun! I experienced a bug though. When I run the script as is, everything is fine but when I generate the diagrams through the static checks ( |
|
Ci is green! I had to revert references to the fab provider because Sphinx does not like referencing in flight documents. I'll create another PR when this one gets merged to essentially revert my last commit and add back these references |
Yeah there is a certain weirdness in it. It mainly comes from the fact that we have the documentation built in parallel and it might be that one package docs is still using the one from the remote "inventory" stored in AWS rather than the one from locally built docs. I sometimes also split such changes into two to make sure it passes the build. |
|
I marked it as 2.8.1 for now @vincbeck -> do you feel that the Auth Manager interface in 2.8 is solid enough to bring the docs update to 2.8.1 and expose to the users? or do you think it should be 2.9.0 ? |
|
#36175 updated the interface and I dont think it is in 2.8. To me, this was the last interface modification and since then, the auth manager interface is solid and should not change |
Create some documentation about the concept of auth manager. Explain as well how to create a new auth manager. Add documentation as well for the FAB auth manager. I also moved some pages and sections from Airflow documentation to Fab provider documentation.
Resolves #32211
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in newsfragments.