Document the faas-cli Device Authorization flow for SSO#431
Conversation
Document the new Device Authorization flow for logging in with the faas-cli. Update the provider instuctions for Keycloak and Google to document enabling support for the Device Authorization flow. Rework the generic SSO CLI page to describe the supported OAuth flows more clearly. Signed-off-by: Han Verstraete (OpenFaaS Ltd) <han@openfaas.com>
This comment has been minimized.
This comment has been minimized.
Signed-off-by: Han Verstraete (OpenFaaS Ltd) <han@openfaas.com>
AI Pull Request OverviewDisclaimer: This review was generated by automated AI and may contain errors. Do not trust its outputs without human verification. Summary
Approval rating (1-10)8/10. The changes are useful and coherent; residual risk is mostly around unverified rendered output because the local docs build tool was unavailable. Summary per fileSummary per file
Overall AssessmentThe PR is ready from a documentation review perspective. The new pages give readers a clear path for choosing between PKCE, Device Authorization, and legacy implicit flows, and the provider-specific Google and Keycloak instructions align with the generic CLI guidance. The intra-page anchors introduced by the new headings appear consistent with MkDocs heading slugs, and the new Google image matches the step it supports. I could not run Detailed ReviewDetailed ReviewContent reviewNo blocking findings. The title and scope of each changed page remain aligned: The opening structure is usable for the likely reader. The generic CLI page first lists all supported grants, then expands the two main interactive flows, which helps users decide before copying commands. The examples are reproducible at the documentation level. Google explicitly calls out the separate TVs and Limited Input devices client for Device Authorization and includes The rendering risk is low. The new links to AI agent details. |
Description
Document the new Device Authorization flow for logging in with the faas-cli.
Update the provider instructions for Keycloak and Google to document enabling support for the Device Authorization flow.
Rework the generic SSO CLI page to describe the supported OAuth flows more clearly.
Motivation and Context
The faas-cli now supports the Device Authorization flow, so the docs need to describe how to use it and how to enable it on supported IdPs.
How Has This Been Tested?
Reviewed the rendered Markdown locally.
Types of changes
Checklist:
git commit -s