Skip to content

Commit f78b279

Browse files
committed
Document why there is no option for fetching JWKS files via HTTP
This seems to be a recurring question. By documenting this in the .proto file, people are more likely to discover the answer themselves.
1 parent 97d956b commit f78b279

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

pkg/proto/configuration/jwt/jwt.proto

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,22 @@ message AuthorizationHeaderParserConfiguration {
3131
// JWKS stored in a separate file.
3232
// The file will be automatically reloaded every 300 seconds.
3333
string jwks_file = 8;
34+
35+
// Note that no option is provided to download a JWKS from a remote
36+
// server via HTTP. This is intentional, for a couple of reasons:
37+
//
38+
// - If the HTTP server is unavailable, this process wouldn't be
39+
// able to launch properly.
40+
//
41+
// - For large build clusters having many storage nodes, such an
42+
// approach would lead to an unnecessary number of requests
43+
// against the HTTP server.
44+
//
45+
// If downloading a JWKS from a remote server is desired, please
46+
// use the jwks_file option in combination with a cron job that
47+
// fetches the JWKS. When running on Kubernetes, one may create a
48+
// CronJob that writes the JWKS into a ConfigMap. The JWKS can then
49+
// be accessed by creating a volume mount for the ConfigMap.
3450
}
3551

3652
// Maximum number of validated tokens to cache in memory. This speeds

0 commit comments

Comments
 (0)