envoyproxy/gateway

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

Open

#5 658 ouverte le 3 avr. 2025

Voir sur GitHub
 (2 commentaires) (1 réaction) (0 assignés)Go (802 forks)auto 404
documentationhelp wanted

Métriques du dépôt

Stars
 (2 871 stars)
Métriques de merge PR
 (Métriques PR en attente)

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/

Guide contributeur

Direction de recherche
Examinez la documentation OIDC existante et créez un exemple de bac a sable utilisant un fournisseur OIDC local comme Dex ou Keycloak. Mettez ensuite a jour la documentation pour guider d'abord les utilisateurs a travers la configuration du bac a sable, y compris les manifestes et les identifiants de test.
Stack technique
go
Domaine
backendsecurity
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
KubernetesOIDC
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70