jwt_authn: Document that timeout is required in http_uri (#14278)

This patch fixes some examples in the documentation that don't include the mandatory `http_uri.timeout` field and don't add the `tls_transport` field required to fetch JWT signature verification keys from HTTPS servers.

Risk Level: None, docs only
Testing: N/A
Docs Changes: Added
Release Notes: N/A

Fixes #14277

Signed-off-by: Juan Hernandez <juan.hernandez@redhat.com>

Mirrored from https://github.com/envoyproxy/envoy @ 424909395c90d7d68f1afeb3427c26c7c85f2672
pull/623/head
data-plane-api(Azure Pipelines) 4 years ago
parent 8987b3c53f
commit 4753762ed7
  1. 5
      envoy/extensions/filters/http/jwt_authn/v3/config.proto
  2. 5
      envoy/extensions/filters/http/jwt_authn/v4alpha/config.proto

@ -48,6 +48,7 @@ option (udpa.annotations.file_status).package_version_status = ACTIVE;
// http_uri:
// uri: https://example.com/.well-known/jwks.json
// cluster: example_jwks_cluster
// timeout: 1s
// cache_duration:
// seconds: 300
//
@ -94,6 +95,7 @@ message JwtProvider {
// http_uri:
// uri: https://www.googleapis.com/oauth2/v1/certs
// cluster: jwt.www.googleapis.com|443
// timeout: 1s
// cache_duration:
// seconds: 300
//
@ -209,6 +211,7 @@ message RemoteJwks {
// http_uri:
// uri: https://www.googleapis.com/oauth2/v1/certs
// cluster: jwt.www.googleapis.com|443
// timeout: 1s
//
config.core.v3.HttpUri http_uri = 1;
@ -451,6 +454,7 @@ message FilterStateRule {
// http_uri:
// uri: https://example.com/.well-known/jwks.json
// cluster: example_jwks_cluster
// timeout: 1s
// provider2:
// issuer: issuer2
// local_jwks:
@ -495,6 +499,7 @@ message JwtAuthentication {
// http_uri:
// uri: https://example.com/.well-known/jwks.json
// cluster: example_jwks_cluster
// timeout: 1s
// provider2:
// issuer: provider2
// local_jwks:

@ -48,6 +48,7 @@ option (udpa.annotations.file_status).package_version_status = NEXT_MAJOR_VERSIO
// http_uri:
// uri: https://example.com/.well-known/jwks.json
// cluster: example_jwks_cluster
// timeout: 1s
// cache_duration:
// seconds: 300
//
@ -94,6 +95,7 @@ message JwtProvider {
// http_uri:
// uri: https://www.googleapis.com/oauth2/v1/certs
// cluster: jwt.www.googleapis.com|443
// timeout: 1s
// cache_duration:
// seconds: 300
//
@ -209,6 +211,7 @@ message RemoteJwks {
// http_uri:
// uri: https://www.googleapis.com/oauth2/v1/certs
// cluster: jwt.www.googleapis.com|443
// timeout: 1s
//
config.core.v4alpha.HttpUri http_uri = 1;
@ -451,6 +454,7 @@ message FilterStateRule {
// http_uri:
// uri: https://example.com/.well-known/jwks.json
// cluster: example_jwks_cluster
// timeout: 1s
// provider2:
// issuer: issuer2
// local_jwks:
@ -495,6 +499,7 @@ message JwtAuthentication {
// http_uri:
// uri: https://example.com/.well-known/jwks.json
// cluster: example_jwks_cluster
// timeout: 1s
// provider2:
// issuer: provider2
// local_jwks:

Loading…
Cancel
Save