Skip to content

Document inferred SSO provider defaults - #435

Open
welteki wants to merge 1 commit into
openfaas:masterfrom
welteki:update-sso-provider-defaults
Open

Document inferred SSO provider defaults#435
welteki wants to merge 1 commit into
openfaas:masterfrom
welteki:update-sso-provider-defaults

Conversation

@welteki

@welteki welteki commented Jul 27, 2026

Copy link
Copy Markdown
Member

Description

Update the Google and Microsoft Entra SSO pages to reflect provider-specific defaults inferred by the faas-cli.

The Google page documents the automatically selected authority and Implicit Id grant, along with the flags available to override those values. The example now only requires a Google client ID.

The Microsoft Entra page documents the automatic http://localhost callback address and the --redirect-host override. The example no longer includes the inferred redirect-host flag.

Motivation and Context

The faas-cli now infers common authentication values for Google and Microsoft Entra. The provider guides should show the simplified command-line experience while continuing to document the available flags and their default values.

  • I have raised an issue to propose this change (required)

How Has This Been Tested?

Reviewed the updated Markdown and verified the examples match the new faas-cli pro behavior.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s

Update the Google and Microsoft Entra SSO examples to omit
authentication flags that are now inferred by the faas-cli.

Document the automatic Google authority and grant defaults, the Entra
localhost callback default, and the flags users can provide to override
those values.

Signed-off-by: Han Verstraete (OpenFaaS Ltd) <han@openfaas.com>
@reviewfn

reviewfn Bot commented Jul 27, 2026

Copy link
Copy Markdown

AI Pull Request Overview

Disclaimer: This review was generated by automated AI and may contain errors. Do not trust its outputs without human verification.

Summary

  • Documentation-only PR updating SSO guidance for Google and Microsoft Entra.
  • Google faas-cli example is simplified to rely on inferred implicit-id grant and Google authority defaults.
  • Microsoft Entra faas-cli example is simplified to rely on the inferred http://localhost redirect host.
  • The changed sections align with the nearby setup steps for provider callback URLs.
  • No blocking correctness, rendering, reproducibility, or publish-quality findings were identified in the scoped diff.

Approval rating (1-10)

9/10. The updates are focused, clear, and consistent with the stated provider-specific defaults, with no blocking issues found in the changed content.

Summary per file

Summary per file
File path Summary
docs/openfaas-pro/sso/google.md Documents inferred Google faas-cli grant and authority defaults; simplifies example command.
docs/openfaas-pro/sso/microsoft-entra.md Documents inferred Entra redirect host default; removes redundant example flag.

Overall Assessment

The PR is safe to merge from a documentation review perspective. The edited sections improve the reader path by explaining which faas-cli values are inferred and by reducing command examples to the values users still need to provide. The examples remain consistent with the provider callback URLs described in each guide.

Detailed Review

Detailed Review

Content review

No blocking findings.

  • The title and scope of both pages still match the edited content: each page remains a provider-specific setup guide with a focused faas-cli subsection.
  • The Google update explains both inferred defaults and names the override flags, so readers can use the shorter command without losing the escape hatch for non-default behavior.
  • The Microsoft Entra update ties the inferred http://localhost redirect host directly to Entra's loopback-IP limitation, which preserves the reason behind the removed flag.
  • The command examples are concise and reproducible for the documented happy path because they leave only provider-specific values for readers to substitute.

AI agent details.

Agent processing time: 1m21.903s
Environment preparation time: 3.309s
Total time from webhook: 1m29.629s

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant