envoyproxy/gateway

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

Open

#5.658 aberto em 3 de abr. de 2025

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

Métricas do repositório

Stars
 (2.871 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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/

Guia do colaborador

Direção de pesquisa
Revise a documentação OIDC existente e crie um exemplo de sandbox usando um provedor OIDC local como Dex ou Keycloak. Em seguida, atualize a documentação para orientar os usuários primeiro pela configuração da sandbox, incluindo manifestos e credenciais de teste.
Pilha de tecnologia
go
Domain
backendsecurity
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
KubernetesOIDC
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70