generated from ghga-de/microservice-repository-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
config_schema.json
377 lines (377 loc) · 11.4 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
{
"additionalProperties": false,
"description": "Modifies the original Settings class provided by the user",
"properties": {
"log_level": {
"default": "INFO",
"description": "The minimum log level to capture.",
"enum": [
"CRITICAL",
"ERROR",
"WARNING",
"INFO",
"DEBUG",
"TRACE"
],
"title": "Log Level",
"type": "string"
},
"service_name": {
"default": "wps",
"title": "Service Name",
"type": "string"
},
"service_instance_id": {
"description": "A string that uniquely identifies this instance across all instances of this service. A globally unique Kafka client ID will be created by concatenating the service_name and the service_instance_id.",
"examples": [
"germany-bw-instance-001"
],
"title": "Service Instance Id",
"type": "string"
},
"log_format": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "If set, will replace JSON formatting with the specified string format. If not set, has no effect. In addition to the standard attributes, the following can also be specified: timestamp, service, instance, level, correlation_id, and details",
"examples": [
"%(timestamp)s - %(service)s - %(level)s - %(message)s",
"%(asctime)s - Severity: %(levelno)s - %(msg)s"
],
"title": "Log Format"
},
"log_traceback": {
"default": true,
"description": "Whether to include exception tracebacks in log messages.",
"title": "Log Traceback",
"type": "boolean"
},
"datasets_collection": {
"default": "datasets",
"description": "The name of the database collection for datasets",
"title": "Datasets Collection",
"type": "string"
},
"work_packages_collection": {
"default": "workPackages",
"description": "The name of the database collection for work packages",
"title": "Work Packages Collection",
"type": "string"
},
"work_package_valid_days": {
"default": 30,
"description": "How many days a work package (and its access token) stays valid",
"title": "Work Package Valid Days",
"type": "integer"
},
"work_package_signing_key": {
"description": "The private key for signing work order tokens",
"examples": [
"{\"crv\": \"P-256\", \"kty\": \"EC\", \"x\": \"...\", \"y\": \"...\"}"
],
"format": "password",
"title": "Work Package Signing Key",
"type": "string",
"writeOnly": true
},
"db_connection_str": {
"description": "MongoDB connection string. Might include credentials. For more information see: https://naiveskill.com/mongodb-connection-string/",
"examples": [
"mongodb://localhost:27017"
],
"format": "password",
"title": "Db Connection Str",
"type": "string",
"writeOnly": true
},
"db_name": {
"default": "work-packages",
"title": "Db Name",
"type": "string"
},
"kafka_servers": {
"description": "A list of connection strings to connect to Kafka bootstrap servers.",
"examples": [
[
"localhost:9092"
]
],
"items": {
"type": "string"
},
"title": "Kafka Servers",
"type": "array"
},
"kafka_security_protocol": {
"default": "PLAINTEXT",
"description": "Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL.",
"enum": [
"PLAINTEXT",
"SSL"
],
"title": "Kafka Security Protocol",
"type": "string"
},
"kafka_ssl_cafile": {
"default": "",
"description": "Certificate Authority file path containing certificates used to sign broker certificates. If a CA is not specified, the default system CA will be used if found by OpenSSL.",
"title": "Kafka Ssl Cafile",
"type": "string"
},
"kafka_ssl_certfile": {
"default": "",
"description": "Optional filename of client certificate, as well as any CA certificates needed to establish the certificate's authenticity.",
"title": "Kafka Ssl Certfile",
"type": "string"
},
"kafka_ssl_keyfile": {
"default": "",
"description": "Optional filename containing the client private key.",
"title": "Kafka Ssl Keyfile",
"type": "string"
},
"kafka_ssl_password": {
"default": "",
"description": "Optional password to be used for the client private key.",
"format": "password",
"title": "Kafka Ssl Password",
"type": "string",
"writeOnly": true
},
"generate_correlation_id": {
"default": true,
"description": "A flag, which, if False, will result in an error when inbound requests don't possess a correlation ID. If True, requests without a correlation ID will be assigned a newly generated ID in the correlation ID middleware function.",
"examples": [
true,
false
],
"title": "Generate Correlation Id",
"type": "boolean"
},
"kafka_max_message_size": {
"default": 1048576,
"description": "The largest message size that can be transmitted, in bytes. Only services that have a need to send/receive larger messages should set this.",
"examples": [
1048576,
16777216
],
"exclusiveMinimum": 0,
"title": "Kafka Max Message Size",
"type": "integer"
},
"dataset_change_event_topic": {
"description": "Name of the topic for events that inform about datasets.",
"examples": [
"metadata_datasets"
],
"title": "Dataset Change Event Topic",
"type": "string"
},
"dataset_upsertion_event_type": {
"description": "The type of events that inform about new and changed datasets.",
"examples": [
"dataset_created"
],
"title": "Dataset Upsertion Event Type",
"type": "string"
},
"dataset_deletion_event_type": {
"description": "The type of events that inform about deleted datasets.",
"examples": [
"dataset_deleted"
],
"title": "Dataset Deletion Event Type",
"type": "string"
},
"download_access_url": {
"description": "URL pointing to the internal download access API.",
"examples": [
"http://127.0.0.1/download-access"
],
"title": "Download Access Url",
"type": "string"
},
"auth_key": {
"description": "The GHGA internal public key for validating the token signature.",
"examples": [
"{\"crv\": \"P-256\", \"kty\": \"EC\", \"x\": \"...\", \"y\": \"...\"}"
],
"title": "Internal public key",
"type": "string"
},
"auth_algs": {
"default": [
"ES256"
],
"description": "A list of all algorithms used for signing GHGA internal tokens.",
"items": {
"type": "string"
},
"title": "Auth Algs",
"type": "array"
},
"auth_check_claims": {
"default": {
"id": null,
"name": null,
"email": null,
"iat": null,
"exp": null
},
"description": "A dict of all GHGA internal claims that shall be verified.",
"title": "Auth Check Claims",
"type": "object"
},
"auth_map_claims": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "A mapping of claims to attributes in the GHGA auth context.",
"title": "Auth Map Claims",
"type": "object"
},
"host": {
"default": "127.0.0.1",
"description": "IP of the host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 8080,
"description": "Port to expose the server on the specified host",
"title": "Port",
"type": "integer"
},
"auto_reload": {
"default": false,
"description": "A development feature. Set to `True` to automatically reload the server upon code changes",
"title": "Auto Reload",
"type": "boolean"
},
"workers": {
"default": 1,
"description": "Number of workers processes to run.",
"title": "Workers",
"type": "integer"
},
"api_root_path": {
"default": "",
"description": "Root path at which the API is reachable. This is relative to the specified host and port.",
"title": "Api Root Path",
"type": "string"
},
"openapi_url": {
"default": "/openapi.json",
"description": "Path to get the openapi specification in JSON format. This is relative to the specified host and port.",
"title": "Openapi Url",
"type": "string"
},
"docs_url": {
"default": "/docs",
"description": "Path to host the swagger documentation. This is relative to the specified host and port.",
"title": "Docs Url",
"type": "string"
},
"cors_allowed_origins": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of origins that should be permitted to make cross-origin requests. By default, cross-origin requests are not allowed. You can use ['*'] to allow any origin.",
"examples": [
[
"https://example.org",
"https://www.example.org"
]
],
"title": "Cors Allowed Origins"
},
"cors_allow_credentials": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicate that cookies should be supported for cross-origin requests. Defaults to False. Also, cors_allowed_origins cannot be set to ['*'] for credentials to be allowed. The origins must be explicitly specified.",
"examples": [
[
"https://example.org",
"https://www.example.org"
]
],
"title": "Cors Allow Credentials"
},
"cors_allowed_methods": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of HTTP methods that should be allowed for cross-origin requests. Defaults to ['GET']. You can use ['*'] to allow all standard methods.",
"examples": [
[
"*"
]
],
"title": "Cors Allowed Methods"
},
"cors_allowed_headers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of HTTP request headers that should be supported for cross-origin requests. Defaults to []. You can use ['*'] to allow all headers. The Accept, Accept-Language, Content-Language and Content-Type headers are always allowed for CORS requests.",
"examples": [
[]
],
"title": "Cors Allowed Headers"
}
},
"required": [
"service_instance_id",
"work_package_signing_key",
"db_connection_str",
"kafka_servers",
"dataset_change_event_topic",
"dataset_upsertion_event_type",
"dataset_deletion_event_type",
"download_access_url",
"auth_key"
],
"title": "ModSettings",
"type": "object"
}