-
Notifications
You must be signed in to change notification settings - Fork 26
/
values.schema.json
492 lines (492 loc) · 19.5 KB
/
values.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
{
"$schema": "http://json-schema.org/schema#",
"type": "object",
"properties": {
"telemetry": {
"type": "object",
"properties": {
"trace": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "enable tracing",
"default": "false"
},
"otlp": {
"type": "object",
"properties": {
"endpoint": {
"type": ["string", "null"],
"description": "the grpc endpoint of the OpenTelemetry 'otlp' trace collector"
}
}
},
"sampleRatio": {
"type": ["number", "null"],
"description": "the fraction of traces to sample. 1 means all, 0 means none.",
"default": null
}
}
},
"metrics": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "enable/disable prometheus metrics on the '/metrics' endpoint",
"default": true
},
"addr": {
"type": "string",
"description": "the host:port address to serve the prometheus metrics server on",
"default": "0.0.0.0:2112"
},
"enableRPCHistograms": {
"type": ["boolean", "null"],
"description": "enables prometheus histogram metrics for RPC latency distributions"
}
}
}
}
},
"datastore": {
"type": "object",
"properties": {
"engine": {
"type": "string",
"enum": ["memory", "postgres", "mysql"],
"default": "memory"
},
"uri": {
"type":["string", "null"]
},
"uriSecret": {
"type":["string", "null"],
"description": "the secret name where to get the datastore URI, it expects a key named uri to exist in the secret"
},
"maxCacheSize": {
"type": ["integer", "null"],
"description": "the maximum number of cache keys that the storage cache can store before evicting old keys"
},
"maxOpenConns": {
"type": ["integer", "null"],
"description": "the maximum number of open connections to the datastore"
},
"maxIdleConns": {
"type": ["integer", "null"],
"description": "the maximum number of connections to the datastore in the idle connection pool"
},
"connMaxIdleTime": {
"type": ["string", "null"],
"description": "the maximum amount of time (as a duration) a connection to the datastore may be idle",
"format": "duration",
"examples": ["30s", "1m", "200ms"]
},
"connMaxLifetime": {
"type": ["string", "null"],
"description": "the maximum amount of time (as a duration) a connection to the datastore may be reused",
"format": "duration",
"examples": ["30s", "1m", "200ms"]
},
"applyMigrations": {
"type": "boolean",
"description": "enable/disable the job that runs migrations in the datastore",
"default": true
}
}
},
"postgres": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "enable the bitnami/postgresql subchart and deploy Postgres",
"default": false
}
}
},
"mysql": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "enable the bitnami/mysql subchart and deploy MySQL",
"default": false
}
}
},
"grpc": {
"type": "object",
"properties": {
"addr": {
"type": "string",
"description": "the host:port address to serve the grpc server on.",
"default": "0.0.0.0:8081"
},
"tls": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "enables or disables transport layer security (TLS)",
"default": false
},
"cert": {
"type": ["string", "null"],
"description": "the (absolute) file path of the certificate to use for the TLS connection"
},
"key": {
"type": ["string", "null"],
"description": "the (absolute) file path of the TLS key that should be used for the TLS connection"
}
}
}
}
},
"http": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "enables or disables the OpenFGA HTTP server. If this is set to true then 'grpc.enabled' must be set to true",
"default": true
},
"addr": {
"type": "string",
"description": "the host:port address to serve the HTTP server on",
"default": "0.0.0.0:8080"
},
"tls": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "enables or disables transport layer security (TLS)",
"default": false
},
"cert": {
"type": ["string", "null"],
"description": "the (absolute) file path of the certificate to use for the TLS connection"
},
"key": {
"type": ["string", "null"],
"description": "the (absolute) file path of the TLS key that should be used for the TLS connection"
}
}
},
"upstreamTimeout": {
"type": ["string", "null"],
"description": "the timeout duration for proxying HTTP requests upstream to the grpc endpoint.",
"format": "duration",
"examples": ["5s", "1m", "200ms"]
},
"corsAllowedOrigins": {
"type": "array",
"items": {
"type": "string"
},
"default": ["*"]
},
"corsAllowedHeaders": {
"type": "array",
"items": {
"type": "string"
},
"default": ["*"]
}
}
},
"authn": {
"type": "object",
"properties": {
"method": {
"type": ["string", "null"],
"description": "the authentication method to use",
"enum": [null, "none", "preshared", "oidc"]
},
"preshared": {
"type": "object",
"properties": {
"keys": {
"type": "array",
"description": "one or more preshared keys to use for authentication (must be set if `authn.method=preshared')",
"items": {
"type": "string",
"minItems": 1
}
}
}
},
"oidc": {
"type": "object",
"properties": {
"audience": {
"type": ["string", "null"],
"description": "the OIDC 'audience' which tokens will be validated against (must be set if `authn.method=oidc`)"
},
"issuer": {
"type": ["string", "null"],
"description": "the OIDC 'issuer' which tokens will be validated against (must be set if `authn.method=oidc`)"
}
}
}
}
},
"playground": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "enable/disable the OpenFGA Playground",
"default": true
},
"port": {
"type": "number",
"description": "the port to serve the local OpenFGA Playground on",
"default": 3000
}
}
},
"profiler": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "enable/disable pprof profiling",
"default": false
},
"addr": {
"type": "string",
"description": "the host:port address to serve the pprof profiler server on",
"default": "0.0.0.0:3001"
}
}
},
"log": {
"type": "object",
"properties": {
"level": {
"type": "string",
"description": "the log level to set (for production we recommend 'info' level)",
"enum": ["debug", "info", "warn", "error", "panic", "fatal"],
"default": "info"
},
"format": {
"type": "string",
"description": "the log format to output logs in (for production we recommend 'json' format)",
"enum": ["text", "json"],
"default": "json"
}
}
},
"experimentals": {
"type": "array",
"description": "a list of experimental features to enable",
"default": []
},
"maxTuplesPerWrite": {
"type": ["integer", "null"],
"description": "the maximum allowed number of tuples per Write transaction"
},
"maxTypesPerAuthorizationModel": {
"type": ["integer", "null"],
"description": "the maximum allowed number of type definitions per authorization model"
},
"changelogHorizonOffset": {
"type": ["integer", "null"],
"description": "the offset (in minutes) from the current time - changes that occur after this offset will not be included in the response of ReadChanges."
},
"resolveNodeLimit": {
"type": ["integer", "null"],
"description": "defines how deeply nested an authorization model can be"
},
"listObjectsDeadline": {
"type": ["string", "null"],
"description": "the timeout deadline (as a duration) for serving ListObjects requests",
"format": "duration",
"examples": ["3s", "1m", "200ms"]
},
"listObjectsMaxResults": {
"type": ["integer", "null"],
"description": "the maximum results to return in ListObjects responses"
},
"allowWriting1_0Models": {
"type": ["boolean", "null"],
"description": "allow calling WriteAuthorizationModel with models that have 1.0 schema version"
},
"allowEvaluating1_0Models": {
"type": ["boolean", "null"],
"description": "allow calling Check, Expand, ListObjects, Write Assertions with models that have 1.0 schema version"
},
"annotations": {
"type": "object",
"description": "Map of annotations to add to the deployment's manifest",
"additionalProperties": { "type": "string" },
"default": { }
},
"podAnnotations": {
"type": "object",
"description": "Map of annotations to add to the pods' manifest",
"additionalProperties": { "type": "string" },
"default": { }
},
"service": {
"type": "object",
"properties": {
"annotations": {
"type": "object",
"description": "Map of annotations to add to the service's manifest",
"additionalProperties": { "type": "string" },
"default": { }
}
}
},
"ingress": {
"type": "object",
"properties": {
"annotations": {
"type": "object",
"description": "Map of annotations to add to the ingress' manifest",
"additionalProperties": { "type": "string" },
"default": { }
}
}
},
"livenessProbe": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable liveness probes on OpenFGA containers."
},
"initialDelaySeconds": {
"type": "number",
"default": 60,
"description": "Number of seconds after the container has started before liveness probes are initiated."
},
"periodSeconds": {
"type": "number",
"default": 10,
"description": "How often (in seconds) to perform the probe."
},
"timeoutSeconds": {
"type": "number",
"default": 5,
"duration": "Number of seconds after which the probe times out."
},
"failureThreshold": {
"type": "number",
"default": 12,
"description": "Failure threshold for liveness probes."
},
"successThreshold": {
"type": "number",
"default": 1,
"description": "Success threshold for liveness probes."
}
}
},
"readinessProbe": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable readiness probes on OpenFGA containers."
},
"initialDelaySeconds": {
"type": "number",
"default": 5,
"description": "Number of seconds after the container has started before readiness probes are initiated."
},
"periodSeconds": {
"type": "number",
"default": 10,
"description": "How often (in seconds) to perform the probe."
},
"timeoutSeconds": {
"type": "number",
"default": 5,
"description": "Number of seconds after which the probe times out."
},
"failureThreshold": {
"type": "number",
"default": 6,
"description": "Failure threshold for readiness probes."
},
"successThreshold": {
"type": "number",
"default": 1,
"description": "Success threshold for readiness probes."
}
}
},
"startupProbe": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable startup probes on OpenFGA containers."
},
"initialDelaySeconds": {
"type": "number",
"default": 60,
"description": "Number of seconds after the container has started before startup probes are initiated."
},
"periodSeconds": {
"type": "number",
"default": 10,
"description": "How often (in seconds) to perform the probe."
},
"timeoutSeconds": {
"type": "number",
"default": 5,
"description": "Number of seconds after which the probe times out."
},
"failureThreshold": {
"type": "number",
"default": 30,
"description": "Failure threshold for readiness probes."
},
"successThreshold": {
"type": "number",
"default": 1,
"description": "Success threshold for readiness probes."
}
}
},
"customLivenessProbe": {
"type": "object",
"default": null,
"description": "Overrides the default liveness probe with a custom one."
},
"customReadinessProbe": {
"type": "object",
"default": null,
"description": "Overrides the default readiness probe with a custom one."
},
"customStartupProbe": {
"type": "object",
"default": null,
"description": "Overrides the default startup probe with a custom one."
},
"sidecars": {
"type": "array",
"description": "add additional sidecar containers to the pods",
"default": []
},
"migrate": {
"type": "object",
"properties": {
"sidecars": {
"type": "array",
"description": "add additional sidecar containers to the migration job",
"default": []
}
}
}
}
}