envoyproxy/gateway

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

Open

#5.658 geöffnet am 3. Apr. 2025

Auf GitHub ansehen
 (2 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Go (802 Forks)auto 404
documentationhelp wanted

Repository-Metriken

Stars
 (2.871 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Prüfen Sie die vorhandene OIDC Dokumentation und erstellen Sie ein Sandbox Beispiel mit einem lokalen OIDC Anbieter wie Dex oder Keycloak. Aktualisieren Sie dann die Dokumentation, um die Benutzer zuerst durch die Sandbox Einrichtung zu führen, einschließlich Manifesten und Testanmeldeinformationen.
Tech Stack
go
Domain
backendsecurity
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
KubernetesOIDC
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70