envoyproxy/envoy

docs: add arch overview docs for oauth2 filter

Open

#13,076 opened on Sep 13, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/docsarea/securityhelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

We should add arch overview docs for the oauth2 filter here: https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/security

It would be good to have a brief discussion about what what it does and compare it to JWT/extauth/etc.

Contributor guide

Research direction
Review the existing security architecture docs at https://www.envoyproxy.io/docs/envoy/latest/intro/arch overview/security/security, then write a new section for the oauth2 filter, comparing it with JWT and ext authz filters. Ensure the content is consistent with Envoy's documentation style.
Tech stack
None
Domain
documentationsecurity
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85