envoyproxy/gateway

docs: Suggestion to Include a Sandbox OIDC Provider for Easier Onboarding

Open

#5,658 opened on Apr 3, 2025

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Go (802 forks)auto 404
documentationhelp wanted

Repository metrics

Stars
 (2,871 stars)
PR merge metrics
 (PR metrics pending)

Description

Description: As a new user, I found it difficult to follow the OIDC Authentication documentation because it requires setting up an external OIDC provider (e.g., Google, Auth0, etc.). The additional setup steps on a separate platform disrupted my flow and made it harder to test OIDC authentication quickly.

To improve the developer experience, I recommend including a sandbox OIDC provider that users can use out-of-the-box without having to register an external OIDC application. This would significantly lower the barrier to testing OIDC authentication in Envoy Gateway.

  • Provide a pre-configured OIDC sandbox as part of the documentation.
  • Offer an example manifest that deploys a local OIDC provider alongside Envoy Gateway in Kubernetes.
  • Include test credentials so users can authenticate without registering an application externally.
  • Modify the existing documentation to first guide users through the sandbox setup before introducing external OIDC providers.

Page: https://gateway.envoyproxy.io/docs/tasks/security/oidc/

Contributor guide

Research direction
Review the existing OIDC documentation and create a sandbox example using a local OIDC provider such as Dex or Keycloak. Then update the docs to guide users through the sandbox setup first, including manifests and test credentials.
Tech stack
go
Domain
backendsecurity
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
KubernetesOIDC
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70