forked from openfga/openfga
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy path.config-schema.json
613 lines (612 loc) · 28.5 KB
/
.config-schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
{
"properties": {
"maxTuplesPerWrite": {
"description": "The maximum allowed number of tuples per Write transaction.",
"type": "integer",
"default": 100,
"x-env-variable": "OPENFGA_MAX_TUPLES_PER_WRITE"
},
"maxTypesPerAuthorizationModel": {
"description": "The maximum allowed number of type definitions per authorization model.",
"type": "integer",
"default": 100,
"x-env-variable": "OPENFGA_MAX_TYPES_PER_AUTHORIZATION_MODEL"
},
"maxAuthorizationModelSizeInBytes": {
"description": "The maximum size in bytes allowed for persisting an Authorization Model (default is 256KB).",
"type": "integer",
"default": 262144,
"x-env-variable": "OPENFGA_MAX_AUTHORIZATION_MODEL_SIZE_IN_BYTES"
},
"maxConcurrentReadsForCheck": {
"description": "The maximum allowed number of concurrent reads in a single Check query (default is MaxUint32).",
"type": "integer",
"default": 4294967295,
"x-env-variable": "OPENFGA_MAX_CONCURRENT_READS_FOR_CHECK"
},
"maxConcurrentReadsForListObjects": {
"description": "The maximum allowed number of concurrent reads in a single ListObjects query (default is MaxUint32).",
"type": "integer",
"default": 4294967295,
"x-env-variable": "OPENFGA_MAX_CONCURRENT_READS_FOR_LIST_OBJECTS"
},
"maxConcurrentReadsForListUsers": {
"description": "The maximum allowed number of concurrent reads in a single ListUsers query (default is MaxUint32).",
"type": "integer",
"default": 4294967295,
"x-env-variable": "OPENFGA_MAX_CONCURRENT_READS_FOR_LIST_USERS"
},
"maxConditionEvaluationCost": {
"description": "The maximum cost for CEL condition evaluation before a request returns an error (default is 100).",
"type": "integer",
"default": 100,
"x-env-variable": "OPENFGA_MAX_CONDITION_EVALUATION_COST"
},
"changelogHorizonOffset": {
"description": "The offset (in minutes) from the current time. Changes that occur after this offset will not be included in the response of ReadChanges.",
"type": "integer",
"default": 0,
"x-env-variable": "OPENFGA_CHANGELOG_HORIZON_OFFSET"
},
"resolveNodeLimit": {
"description": "Maximum resolution depth to attempt before throwing an error (defines how deeply nested an authorization model can be before a query errors out).",
"type": "integer",
"default": 25,
"x-env-variable": "OPENFGA_RESOLVE_NODE_LIMIT"
},
"resolveNodeBreadthLimit": {
"description": "Defines how many nodes on a given level can be evaluated concurrently in a Check resolution tree.",
"type": "integer",
"default": 100,
"x-env-variable": "OPENFGA_RESOLVE_NODE_BREADTH_LIMIT"
},
"listObjectsDeadline": {
"description": "The timeout deadline for serving ListObjects requests",
"type": "string",
"format": "duration",
"default": "3s",
"x-env-variable": "OPENFGA_LIST_OBJECTS_DEADLINE"
},
"listObjectsMaxResults": {
"description": "The maximum results to return in the non-streaming ListObjects API response. If 0, all results can be returned",
"type": "integer",
"minimum": 0,
"default": 1000,
"x-env-variable": "OPENFGA_LIST_OBJECTS_MAX_RESULTS"
},
"listUsersDeadline": {
"description": "The timeout deadline for serving ListUsers requests. If 0s, there is no deadline",
"type": "string",
"format": "duration",
"default": "3s",
"x-env-variable": "OPENFGA_LIST_USERS_DEADLINE"
},
"listUsersMaxResults": {
"description": "The maximum results to return in ListUsers API response. If 0, all results can be returned",
"type": "integer",
"minimum": 0,
"default": 1000,
"x-env-variable": "OPENFGA_LIST_USERS_MAX_RESULTS"
},
"requestDurationDatastoreQueryCountBuckets": {
"description": "Datastore query count buckets used to label the histogram metric for measuring request duration.",
"type": "array",
"items": {
"minimum": 0,
"type": "integer"
},
"minItems": 1,
"default": [50, 200],
"x-env-variable": "OPENFGA_REQUEST_DURATION_DATASTORE_QUERY_COUNT_BUCKETS"
},
"requestDurationDispatchCountBuckets": {
"description": "Dispatch count buckets used to label the histogram metric for measuring request duration.",
"type": "array",
"items": {
"minimum": 0,
"type": "integer"
},
"minItems": 1,
"default": [50, 200],
"x-env-variable": "OPENFGA_REQUEST_DURATION_DISPATCH_COUNT_BUCKETS"
},
"experimentals": {
"description": "a list of experimental features to enable",
"type": "array",
"items": {
"type": "string",
"enum": ["enable-consistency-params"]
},
"default": [],
"x-env-variable": "OPENFGA_EXPERIMENTALS"
},
"checkTrackerEnabled": {
"type": "object",
"properties": {
"enabled": {
"description": "Enable logging of statistics for Check requests. For every Check request, log the number of hits that each node in the graph of the authorization model receives. The logs are flushed every 500 milliseconds. These statistics will be used to improve the strategy used to cache Check sub-problems.",
"type": "boolean",
"default": false,
"x-env-variable": "OPENFGA_CHECK_TRACKER_ENABLED"
}
}
},
"playground": {
"type": "object",
"properties": {
"enabled": {
"description": "Enable/disable the OpenFGA Playground.",
"type": "boolean",
"default": true,
"x-env-variable": "OPENFGA_PLAYGROUND_ENABLED"
},
"port": {
"description": "The port to serve the local OpenFGA Playground on.",
"type": "integer",
"default": 3000,
"x-env-variable": "OPENFGA_PLAYGROUND_PORT"
}
}
},
"profiler": {
"type": "object",
"properties": {
"enabled": {
"description": "Enabled/disable pprof profiling.",
"type": "boolean",
"default": false,
"x-env-variable": "OPENFGA_PROFILER_ENABLED"
},
"addr": {
"description": "The host:port address to serve the pprof profiler server on.",
"type": "string",
"default": ":3001",
"x-env-variable": "OPENFGA_PROFILER_ADDR"
}
}
},
"datastore": {
"type": "object",
"properties": {
"engine": {
"description": "The datastore engine that will be used for persistence.",
"type": "string",
"enum": ["memory", "postgres", "mysql"],
"default": "memory",
"x-env-variable": "OPENFGA_DATASTORE_ENGINE"
},
"uri": {
"description": "The connection uri to use to connect to the datastore (for any engine other than 'memory').",
"type": "string",
"examples": [
"postgres://user:pass@host:port/datastore?opts",
"user:pass@tcp(mysql-host:port)/datastore?parseTime=true&other-opts"
],
"x-env-variable": "OPENFGA_DATASTORE_URI"
},
"username": {
"description": "The connection username to connect to the datastore (overwrites any username provided in the connection uri).",
"type": "string",
"x-env-variable": "OPENFGA_DATASTORE_USERNAME"
},
"password": {
"description": "The connection password to connect to the datastore (overwrites any password provided in the connection uri).",
"type": "string",
"x-env-variable": "OPENFGA_DATASTORE_PASSWORD"
},
"maxCacheSize": {
"description": "The maximum number of authorization models that will be cached in memory",
"type": "integer",
"default": 100000,
"x-env-variable": "OPENFGA_DATASTORE_MAX_CACHE_SIZE"
},
"maxOpenConns": {
"description": "The maximum number of open connections to the datastore.",
"type": "integer",
"default": "30",
"x-env-variable": "OPENFGA_DATASTORE_MAX_OPEN_CONNS"
},
"maxIdleConns": {
"description": "the maximum number of connections to the datastore in the idle connection pool.",
"type": "integer",
"default": "10",
"x-env-variable": "OPENFGA_DATASTORE_MAX_IDLE_CONNS"
},
"connMaxIdleTime": {
"description": "the maximum amount of time a connection to the datastore may be idle",
"type": "duration",
"default": "connections are not closed due to idle time - database/sql default",
"x-env-variable": "OPENFGA_DATASTORE_CONN_MAX_IDLE_TIME"
},
"connMaxLifetime": {
"description": "the maximum amount of time a connection to the datastore may be reused",
"type": "duration",
"default": "connections are not closed due to connection's age - database/sql default",
"x-env-variable": "OPENFGA_DATASTORE_CONN_MAX_LIFETIME"
},
"metrics": {
"type": "object",
"properties": {
"enabled": {
"description": "enable/disable sql metrics for the datastore",
"type": "boolean",
"default": false,
"x-env-variable": "OPENFGA_DATASTORE_METRICS_ENABLED"
}
}
}
}
},
"authn": {
"type": "object",
"properties": {
"method": {
"description": "The authentication method to use.",
"type": "string",
"enum": ["none", "preshared", "oidc"],
"default": "none",
"x-env-variable": "OPENFGA_AUTHN_METHOD"
},
"preshared": {
"description": "One or more preshared keys to use for authentication. This must be set if `authn.method=preshared'.",
"$ref": "#/definitions/preshared"
},
"oidc": {
"description": "The OIDC provider specific settings. This must be set if 'authn.method=oidc'.",
"$ref": "#/definitions/oidc"
}
}
},
"grpc": {
"type": "object",
"properties": {
"addr": {
"description": "The host:port address to serve the grpc server on.",
"type": "string",
"default": "0.0.0.0:8081",
"x-env-variable": "OPENFGA_GRPC_ADDR"
},
"tls": {
"type": "object",
"properties": {
"enabled": {
"description": "Enables or disables transport layer security (TLS).",
"type": "boolean",
"default": false,
"x-env-variable": "OPENFGA_GRPC_TLS_ENABLED"
},
"cert": {
"description": "The (absolute) file path of the certificate to use for the TLS connection.",
"type": "string",
"x-env-variable": "OPENFGA_GRPC_TLS_CERT"
},
"key": {
"description": "The (absolute) file path of the TLS key that should be used for the TLS connection.",
"x-env-variable": "OPENFGA_GRPC_TLS_KEY"
}
},
"required": ["enabled", "cert", "key"]
}
}
},
"http": {
"type": "object",
"properties": {
"enabled": {
"description": "Enables or disables the OpenFGA HTTP server. If this is set to true then 'grpc.enabled' must be set to true.",
"type": "boolean",
"default": true,
"x-env-variable": "OPENFGA_HTTP_ENABLED"
},
"addr": {
"description": "The host:port address to serve the HTTP server on.",
"type": "string",
"default": "0.0.0.0:8080",
"x-env-variable": "OPENFGA_HTTP_ADDR"
},
"tls": {
"type": "object",
"properties": {
"enabled": {
"description": "Enables or disables transport layer security (TLS).",
"type": "boolean",
"default": false,
"x-env-variable": "OPENFGA_HTTP_TLS_ENABLED"
},
"cert": {
"description": "The (absolute) file path of the certificate to use for the TLS connection.",
"type": "string",
"x-env-variable": "OPENFGA_HTTP_TLS_CERT"
},
"key": {
"description": "The (absolute) file path of the TLS key that should be used for the TLS connection.",
"x-env-variable": "OPENFGA_HTTP_TLS_KEY"
}
},
"required": ["enabled", "cert", "key"]
},
"upstreamTimeout": {
"description": "The timeout duration for proxying HTTP requests upstream to the grpc endpoint.",
"type": "string",
"default": "3s",
"x-env-variable": "OPENFGA_HTTP_UPSTREAM_TIMEOUT"
},
"corsAllowedOrigins": {
"type": "array",
"items": {
"type": "string"
},
"default": ["*"],
"x-env-variable": "OPENFGA_HTTP_CORS_ALLOWED_ORIGINS"
},
"corsAllowedHeaders": {
"type": "array",
"items": {
"type": "string"
},
"default": ["*"],
"x-env-variable": "OPENFGA_HTTP_CORS_ALLOWED_HEADERS"
}
}
},
"log": {
"type": "object",
"properties": {
"format": {
"description": "The log format to output logs in. For production we recommend 'json' format.",
"type": "string",
"enum": ["text", "json"],
"default": "text",
"x-env-variable": "OPENFGA_LOG_FORMAT"
},
"level": {
"description": "The log level to set. For production we recommend 'info' format.",
"type": "string",
"enum": ["none", "debug", "info", "warn", "error", "panic", "fatal"],
"default": "info",
"x-env-variable": "OPENFGA_LOG_LEVEL"
},
"timestampFormat": {
"description": "The timestamp format to use for the log output.",
"type": "string",
"enum": ["Unix", "ISO8601"],
"default": "Unix",
"x-env-variable": "OPENFGA_LOG_TIMESTAMP_FORMAT"
}
}
},
"trace": {
"type": "object",
"properties": {
"enabled": {
"description": "Enable tracing.",
"type": "bool",
"default": "false",
"x-env-variable": "OPENFGA_TRACE_ENABLED"
},
"otlp": {
"type": "object",
"properties": {
"endpoint": {
"description": "The grpc endpoint of the trace collector",
"type": "string",
"default": "0.0.0.0:4317",
"x-env-variable": "OPENFGA_TRACE_OTLP_ENDPOINT"
},
"tls": {
"type": "object",
"properties": {
"enabled": {
"description": "Whether to use TLS connection for the trace collector",
"type": "boolean",
"default": false,
"x-env-variable": "OPENFGA_TRACE_OTLP_TLS_ENABLED"
}
}
}
}
},
"sampleRatio": {
"description": "The fraction of traces to sample. 1 means all, 0 means none.",
"type": "float",
"default": "0.2",
"x-env-variable": "OPENFGA_TRACE_SAMPLE_RATIO"
},
"serviceName": {
"description": "The service name included in sampled traces.",
"type": "string",
"default": "openfga",
"x-env-variable": "OPENFGA_TRACE_SERVICE_NAME"
}
}
},
"metrics": {
"type": "object",
"properties": {
"enabled": {
"description": "enable/disable prometheus metrics on the '/metrics' endpoint",
"type": "bool",
"default": "true",
"x-env-variable": "OPENFGA_METRICS_ENABLED"
},
"addr": {
"description": "the host:port address to serve the prometheus metrics server on",
"type": "string",
"default": "0.0.0.0:2112",
"x-env-variable": "OPENFGA_METRICS_ADDR"
},
"enableRPCHistograms": {
"description": "enables prometheus histogram metrics for RPC latency distributions",
"type": "bool",
"default": "false",
"x-env-variable": "OPENFGA_METRICS_ENABLE_RPC_HISTOGRAMS"
}
}
},
"checkQueryCache": {
"type": "object",
"properties": {
"enabled": {
"description": "enable caching of Check requests. For example, if you have a relation `define viewer: owner or editor`, and the query is Check(user:anne, viewer, doc:1), we'll evaluate the `owner` relation and the `editor` relation and cache both results: (user:anne, viewer, doc:1) -> allowed=true and (user:anne, owner, doc:1) -> allowed=true. The cache is stored in-memory; the cached values are overwritten on every change in the result, and cleared after the configured TTL. This flag improves latency, but turns Check and ListObjects into eventually consistent APIs.",
"type": "bool",
"default": "false",
"x-env-variable": "OPENFGA_CHECK_QUERY_CACHE_ENABLED"
},
"limit": {
"description": "if caching of Check and ListObjects calls is enabled, this is the size limit (in items) of the cache",
"type": "integer",
"default": "10000",
"x-env-variable": "OPENFGA_CHECK_QUERY_CACHE_LIMIT"
},
"ttl": {
"description": "if caching of Check and ListObjects is enabled, this is the TTL of each value",
"type": "string",
"format": "duration",
"default": "10s",
"x-env-variable": "OPENFGA_CHECK_QUERY_CACHE_TTL"
}
}
},
"dispatchThrottling": {
"type": "object",
"properties": {
"enabled": {
"description": "DEPRECATED: Use checkDispatchThrottling.enabled instead. enable throttling when request's number of dispatches is high",
"type": "bool",
"default": "false",
"x-env-variable": "OPENFGA_DISPATCH_THROTTLING_ENABLED"
},
"frequency": {
"description": "DEPRECATED: Use checkDispatchThrottling.frequency instead. the frequency period that the deprioritized throttling queue is evaluated. A higher value will result in more aggressive throttling",
"type": "duration",
"default": "10µs",
"x-env-variable": "OPENFGA_DISPATCH_THROTTLING_FREQUENCY"
},
"threshold": {
"description": "DEPRECATED: Use checkDispatchThrottling.threshold instead. define the number of recursive operations to occur before getting throttled",
"type": "integer",
"default": "100",
"x-env-variable": "OPENFGA_DISPATCH_THROTTLING_THRESHOLD"
},
"maxThreshold": {
"description": "DEPRECATED: Use checkDispatchThrottling.maxThreshold instead. define the maximum dispatch threshold beyond above which requests will be throttled. 0 will use the 'dispatchThrottling.threshold' value as maximum",
"type": "integer",
"default": "0",
"x-env-variable": "OPENFGA_DISPATCH_THROTTLING_MAX_THRESHOLD"
}
}
},
"checkDispatchThrottling": {
"type": "object",
"properties": {
"enabled": {
"description": "enable throttling when check request's number of dispatches is high",
"type": "bool",
"default": "false",
"x-env-variable": "OPENFGA_CHECK_DISPATCH_THROTTLING_ENABLED"
},
"frequency": {
"description": "the frequency period that the deprioritized throttling queue is evaluated for a check request. A higher value will result in more aggressive throttling",
"type": "duration",
"default": "10µs",
"x-env-variable": "OPENFGA_CHECK_DISPATCH_THROTTLING_FREQUENCY"
},
"threshold": {
"description": "define the number of recursive operations to occur before getting throttled for a check request",
"type": "integer",
"default": "100",
"x-env-variable": "OPENFGA_CHECK_DISPATCH_THROTTLING_THRESHOLD"
},
"maxThreshold": {
"description": "define the maximum dispatch threshold beyond above which requests will be throttled. 0 will use the 'dispatchThrottling.threshold' value as maximum",
"type": "integer",
"default": "0",
"x-env-variable": "OPENFGA_CHECK_DISPATCH_THROTTLING_MAX_THRESHOLD"
}
}
},
"listObjectsDispatchThrottling": {
"type": "object",
"properties": {
"enabled": {
"description": "enable throttling when list objects request's number of dispatches is high",
"type": "bool",
"default": "false",
"x-env-variable": "OPENFGA_LIST_OBJECTS_DISPATCH_THROTTLING_ENABLED"
},
"frequency": {
"description": "the frequency period that the deprioritized throttling queue is evaluated for a list objects request. A higher value will result in more aggressive throttling",
"type": "duration",
"default": "10µs",
"x-env-variable": "OPENFGA_LIST_OBJECTS_DISPATCH_THROTTLING_FREQUENCY"
},
"threshold": {
"description": "define the number of recursive operations to occur before getting throttled for a list objects request",
"type": "integer",
"default": "100",
"x-env-variable": "OPENFGA_LIST_OBJECTS_DISPATCH_THROTTLING_THRESHOLD"
},
"maxThreshold": {
"description": "define the maximum dispatch threshold beyond above which requests will be throttled for a list objects request. 0 will use the 'dispatchThrottling.threshold' value as maximum",
"type": "integer",
"default": "0",
"x-env-variable": "OPENFGA_LIST_OBJECTS_DISPATCH_THROTTLING_MAX_THRESHOLD"
}
}
},
"requestTimeout": {
"description": "The timeout duration for a request.",
"type": "duration",
"default": "3s",
"x-env-variable": "OPENFGA_REQUEST_TIMEOUT"
}
},
"definitions": {
"oidc": {
"type": "object",
"properties": {
"issuer": {
"description": "The OIDC issuer (authorization server) signing the tokens.",
"type": "string",
"x-env-variable": "OPENFGA_AUTHN_OIDC_ISSUER"
},
"audience": {
"description": "The OIDC audience of the tokens being signed by the authorization server.",
"type": "string",
"x-env-variable": "OPENFGA_AUTHN_OIDC_AUDIENCE"
},
"issuerAliases": {
"description": "the OIDC issuer DNS aliases that will be accepted as valid when verifying the `iss` field of the JWTs.",
"type": "array",
"items": {
"type": "string"
},
"x-env-variable": "OPENFGA_AUTHN_OIDC_ISSUER_ALIASES"
},
"subjects": {
"description": "the OIDC subject names that will be accepted as valid when verifying the `sub` field of the JWTs. If empty, every `sub` will be allowed",
"type": "array",
"items": {
"type": "string"
},
"x-env-variable": "OPENFGA_AUTHN_OIDC_SUBJECTS"
}
},
"required": ["issuer", "audience"]
},
"preshared": {
"type": "object",
"properties": {
"keys": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"x-env-variable": "OPENFGA_AUTHN_PRESHARED_KEYS"
}
},
"required": ["keys"]
}
}
}