Token and Authorization docs #2773
Conversation
I did this while I was working on docs for the tool. Adding the SilenceUsage option to cobra prevents the command from dumping all the options/flags/usage info in the event of an error. I prefer this because most errors the command produces don't warrant spamming people with all this info.
This documentation is meant to live at the level of "how can I as a user get protected data", not how an extensive explanation of how the Pelican token ecosystem works or how Origin admins can set up their services with OAuth2 providers. I plan to write a more extensive "how tokens in Pelican" work page in the "Advanced" section, and this commit is a checkpoint while I work toward that. As such, I already link to that page (which I have sketched out locally).
|
For the reviewers, please think carefully about the content of what I'm saying, especially in the "advanced" section -- while I used some AI to help with formatting and clarity, 99% of the content first traveled through my fingers. I likely made mistakes! In particular, it'd be useful for others to think about the descriptions/diagrams in the section about establishing trust, which turned out to be pretty tricky and I'm not totally sure I got it right. I also highly recommend you actually build these docs to see formatting, double check my links, etc. I tried to double check everything before requesting a review, but there's a lot of content and I'm becoming blind to it because of how long I've been staring at it... |
|
I should also note that these docs still aren't a complete "everything auth in Pelican" -- I'm punting on things like "how to set up the built-in issuer". I think some of those topics can/should be added in a followup PR. |
1 participant
A few notes about this: