-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
settings_schema.json
1645 lines (1645 loc) · 74.1 KB
/
settings_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
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$defs": {
"APISettings": {
"description": "Settings for interacting with the Prefect API",
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The URL of the Prefect API. If not set, the client will attempt to infer it.",
"title": "Url"
},
"key": {
"anyOf": [
{
"format": "password",
"type": "string",
"writeOnly": true
},
{
"type": "null"
}
],
"default": null,
"description": "The API key used for authentication with the Prefect API. Should be kept secret.",
"title": "Key"
},
"tls_insecure_skip_verify": {
"default": false,
"description": "If `True`, disables SSL checking to allow insecure requests. This is recommended only during development, e.g. when using self-signed certificates.",
"title": "Tls Insecure Skip Verify",
"type": "boolean"
},
"ssl_cert_file": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "This configuration settings option specifies the path to an SSL certificate file.",
"title": "Ssl Cert File"
},
"enable_http2": {
"default": false,
"description": "If true, enable support for HTTP/2 for communicating with an API. If the API does not support HTTP/2, this will have no effect and connections will be made via HTTP/1.1.",
"title": "Enable Http2",
"type": "boolean"
},
"request_timeout": {
"default": 60.0,
"description": "The default timeout for requests to the API",
"title": "Request Timeout",
"type": "number"
}
},
"title": "APISettings",
"type": "object"
},
"CLISettings": {
"description": "Settings for controlling CLI behavior",
"properties": {
"colors": {
"default": true,
"description": "If True, use colors in CLI output. If `False`, output will not include colors codes.",
"title": "Colors",
"type": "boolean"
},
"prompt": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "If `True`, use interactive prompts in CLI commands. If `False`, no interactive prompts will be used. If `None`, the value will be dynamically determined based on the presence of an interactive-enabled terminal.",
"title": "Prompt"
},
"wrap_lines": {
"default": true,
"description": "If `True`, wrap text by inserting new lines in long lines in CLI output. If `False`, output will not be wrapped.",
"title": "Wrap Lines",
"type": "boolean"
}
},
"title": "CLISettings",
"type": "object"
},
"ClientMetricsSettings": {
"description": "Settings for controlling metrics reporting from the client",
"properties": {
"enabled": {
"default": false,
"description": "Whether or not to enable Prometheus metrics in the client.",
"title": "Enabled",
"type": "boolean"
},
"port": {
"default": 4201,
"description": "The port to expose the client Prometheus metrics on.",
"title": "Port",
"type": "integer"
}
},
"title": "ClientMetricsSettings",
"type": "object"
},
"ClientSettings": {
"description": "Settings for controlling API client behavior",
"properties": {
"max_retries": {
"default": 5,
"description": "\n The maximum number of retries to perform on failed HTTP requests.\n Defaults to 5. Set to 0 to disable retries.\n See `PREFECT_CLIENT_RETRY_EXTRA_CODES` for details on which HTTP status codes are\n retried.\n ",
"minimum": 0,
"title": "Max Retries",
"type": "integer"
},
"retry_jitter_factor": {
"default": 0.2,
"description": "\n A value greater than or equal to zero to control the amount of jitter added to retried\n client requests. Higher values introduce larger amounts of jitter.\n Set to 0 to disable jitter. See `clamped_poisson_interval` for details on the how jitter\n can affect retry lengths.\n ",
"minimum": 0.0,
"title": "Retry Jitter Factor",
"type": "number"
},
"retry_extra_codes": {
"anyOf": [
{
"type": "string"
},
{
"maximum": 599,
"minimum": 100,
"type": "integer"
},
{
"items": {
"maximum": 599,
"minimum": 100,
"type": "integer"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"description": "\n A list of extra HTTP status codes to retry on. Defaults to an empty list.\n 429, 502 and 503 are always retried. Please note that not all routes are idempotent and retrying\n may result in unexpected behavior.\n ",
"examples": [
"404,429,503",
"429",
[
404,
429,
503
]
],
"title": "Retry Extra Codes"
},
"csrf_support_enabled": {
"default": true,
"description": "\n Determines if CSRF token handling is active in the Prefect client for API\n requests.\n\n When enabled (`True`), the client automatically manages CSRF tokens by\n retrieving, storing, and including them in applicable state-changing requests\n ",
"title": "Csrf Support Enabled",
"type": "boolean"
},
"metrics": {
"$ref": "#/$defs/ClientMetricsSettings"
}
},
"title": "ClientSettings",
"type": "object"
},
"CloudSettings": {
"description": "Settings for interacting with Prefect Cloud",
"properties": {
"api_url": {
"default": "https://api.prefect.cloud/api",
"description": "API URL for Prefect Cloud. Used for authentication with Prefect Cloud.",
"title": "Api Url",
"type": "string"
},
"ui_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The URL of the Prefect Cloud UI. If not set, the client will attempt to infer it.",
"title": "Ui Url"
}
},
"title": "CloudSettings",
"type": "object"
},
"DeploymentsSettings": {
"description": "Settings for configuring deployments defaults",
"properties": {
"default_work_pool_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The default work pool to use when creating deployments.",
"title": "Default Work Pool Name"
},
"default_docker_build_namespace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The default Docker namespace to use when building images.",
"examples": [
"my-dockerhub-registry",
"4999999999999.dkr.ecr.us-east-2.amazonaws.com/my-ecr-repo"
],
"title": "Default Docker Build Namespace"
}
},
"title": "DeploymentsSettings",
"type": "object"
},
"FlowsSettings": {
"description": "Settings for controlling flow behavior",
"properties": {
"default_retries": {
"default": 0,
"description": "This value sets the default number of retries for all flows.",
"minimum": 0,
"title": "Default Retries",
"type": "integer"
},
"default_retry_delay_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"items": {
"type": "number"
},
"type": "array"
}
],
"default": 0,
"description": "This value sets the default retry delay seconds for all flows.",
"title": "Default Retry Delay Seconds"
}
},
"title": "FlowsSettings",
"type": "object"
},
"InternalSettings": {
"properties": {
"logging_level": {
"default": "ERROR",
"description": "The default logging level for Prefect's internal machinery loggers.",
"enum": [
"DEBUG",
"INFO",
"WARNING",
"ERROR",
"CRITICAL"
],
"title": "Logging Level",
"type": "string"
}
},
"title": "InternalSettings",
"type": "object"
},
"LoggingSettings": {
"description": "Settings for controlling logging behavior",
"properties": {
"level": {
"default": "INFO",
"description": "The default logging level for Prefect loggers.",
"enum": [
"DEBUG",
"INFO",
"WARNING",
"ERROR",
"CRITICAL"
],
"title": "Level",
"type": "string"
},
"config_path": {
"anyOf": [
{
"format": "path",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The path to a custom YAML logging configuration file.",
"title": "Config Path"
},
"extra_loggers": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Additional loggers to attach to Prefect logging at runtime.",
"title": "Extra Loggers"
},
"log_prints": {
"default": false,
"description": "If `True`, `print` statements in flows and tasks will be redirected to the Prefect logger for the given run.",
"title": "Log Prints",
"type": "boolean"
},
"colors": {
"default": true,
"description": "If `True`, use colors in CLI output. If `False`, output will not include colors codes.",
"title": "Colors",
"type": "boolean"
},
"markup": {
"default": false,
"description": "\n Whether to interpret strings wrapped in square brackets as a style.\n This allows styles to be conveniently added to log messages, e.g.\n `[red]This is a red message.[/red]`. However, the downside is, if enabled,\n strings that contain square brackets may be inaccurately interpreted and\n lead to incomplete output, e.g.\n `[red]This is a red message.[/red]` may be interpreted as\n `[red]This is a red message.[/red]`.\n ",
"title": "Markup",
"type": "boolean"
},
"to_api": {
"$ref": "#/$defs/LoggingToAPISettings"
}
},
"title": "LoggingSettings",
"type": "object"
},
"LoggingToAPISettings": {
"description": "Settings for controlling logging to the API",
"properties": {
"enabled": {
"default": true,
"description": "If `True`, logs will be sent to the API.",
"title": "Enabled",
"type": "boolean"
},
"batch_interval": {
"default": 2.0,
"description": "The number of seconds between batched writes of logs to the API.",
"title": "Batch Interval",
"type": "number"
},
"batch_size": {
"default": 4000000,
"description": "The number of logs to batch before sending to the API.",
"title": "Batch Size",
"type": "integer"
},
"max_log_size": {
"default": 1000000,
"description": "The maximum size in bytes for a single log.",
"title": "Max Log Size",
"type": "integer"
},
"when_missing_flow": {
"default": "warn",
"description": "\n Controls the behavior when loggers attempt to send logs to the API handler from outside of a flow.\n \n All logs sent to the API must be associated with a flow run. The API log handler can\n only be used outside of a flow by manually providing a flow run identifier. Logs\n that are not associated with a flow run will not be sent to the API. This setting can\n be used to determine if a warning or error is displayed when the identifier is missing.\n\n The following options are available:\n\n - \"warn\": Log a warning message.\n - \"error\": Raise an error.\n - \"ignore\": Do not log a warning message or raise an error.\n ",
"enum": [
"warn",
"error",
"ignore"
],
"title": "When Missing Flow",
"type": "string"
}
},
"title": "LoggingToAPISettings",
"type": "object"
},
"ResultsSettings": {
"description": "Settings for controlling result storage behavior",
"properties": {
"default_serializer": {
"default": "pickle",
"description": "The default serializer to use when not otherwise specified.",
"title": "Default Serializer",
"type": "string"
},
"persist_by_default": {
"default": false,
"description": "The default setting for persisting results when not otherwise specified.",
"title": "Persist By Default",
"type": "boolean"
},
"default_storage_block": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The `block-type/block-document` slug of a block to use as the default result storage.",
"title": "Default Storage Block"
},
"local_storage_path": {
"anyOf": [
{
"format": "path",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The path to a directory to store results in.",
"title": "Local Storage Path"
}
},
"title": "ResultsSettings",
"type": "object"
},
"RunnerServerSettings": {
"description": "Settings for controlling runner server behavior",
"properties": {
"enable": {
"default": false,
"description": "Whether or not to enable the runner's webserver.",
"title": "Enable",
"type": "boolean"
},
"host": {
"default": "localhost",
"description": "The host address the runner's webserver should bind to.",
"title": "Host",
"type": "string"
},
"port": {
"default": 8080,
"description": "The port the runner's webserver should bind to.",
"title": "Port",
"type": "integer"
},
"log_level": {
"default": "error",
"description": "The log level of the runner's webserver.",
"enum": [
"DEBUG",
"INFO",
"WARNING",
"ERROR",
"CRITICAL"
],
"title": "Log Level",
"type": "string"
},
"missed_polls_tolerance": {
"default": 2,
"description": "Number of missed polls before a runner is considered unhealthy by its webserver.",
"title": "Missed Polls Tolerance",
"type": "integer"
}
},
"title": "RunnerServerSettings",
"type": "object"
},
"RunnerSettings": {
"description": "Settings for controlling runner behavior",
"properties": {
"process_limit": {
"default": 5,
"description": "Maximum number of processes a runner will execute in parallel.",
"title": "Process Limit",
"type": "integer"
},
"poll_frequency": {
"default": 10,
"description": "Number of seconds a runner should wait between queries for scheduled work.",
"title": "Poll Frequency",
"type": "integer"
},
"server": {
"$ref": "#/$defs/RunnerServerSettings"
}
},
"title": "RunnerSettings",
"type": "object"
},
"ServerAPISettings": {
"description": "Settings for controlling API server behavior",
"properties": {
"host": {
"default": "127.0.0.1",
"description": "The API's host address (defaults to `127.0.0.1`).",
"title": "Host",
"type": "string"
},
"port": {
"default": 4200,
"description": "The API's port address (defaults to `4200`).",
"title": "Port",
"type": "integer"
},
"default_limit": {
"default": 200,
"description": "The default limit applied to queries that can return multiple objects, such as `POST /flow_runs/filter`.",
"title": "Default Limit",
"type": "integer"
},
"keepalive_timeout": {
"default": 5,
"description": "\n The API's keep alive timeout (defaults to `5`).\n Refer to https://www.uvicorn.org/settings/#timeouts for details.\n\n When the API is hosted behind a load balancer, you may want to set this to a value\n greater than the load balancer's idle timeout.\n\n Note this setting only applies when calling `prefect server start`; if hosting the\n API with another tool you will need to configure this there instead.\n ",
"title": "Keepalive Timeout",
"type": "integer"
},
"csrf_protection_enabled": {
"default": false,
"description": "\n Controls the activation of CSRF protection for the Prefect server API.\n\n When enabled (`True`), the server enforces CSRF validation checks on incoming\n state-changing requests (POST, PUT, PATCH, DELETE), requiring a valid CSRF\n token to be included in the request headers or body. This adds a layer of\n security by preventing unauthorized or malicious sites from making requests on\n behalf of authenticated users.\n\n It is recommended to enable this setting in production environments where the\n API is exposed to web clients to safeguard against CSRF attacks.\n\n Note: Enabling this setting requires corresponding support in the client for\n CSRF token management. See PREFECT_CLIENT_CSRF_SUPPORT_ENABLED for more.\n ",
"title": "Csrf Protection Enabled",
"type": "boolean"
},
"csrf_token_expiration": {
"default": "PT1H",
"description": "\n Specifies the duration for which a CSRF token remains valid after being issued\n by the server.\n\n The default expiration time is set to 1 hour, which offers a reasonable\n compromise. Adjust this setting based on your specific security requirements\n and usage patterns.\n ",
"format": "duration",
"title": "Csrf Token Expiration",
"type": "string"
},
"cors_allowed_origins": {
"default": "*",
"description": "\n A comma-separated list of origins that are authorized to make cross-origin requests to the API.\n\n By default, this is set to `*`, which allows requests from all origins.\n ",
"title": "Cors Allowed Origins",
"type": "string"
},
"cors_allowed_methods": {
"default": "*",
"description": "\n A comma-separated list of methods that are authorized to make cross-origin requests to the API.\n\n By default, this is set to `*`, which allows requests from all methods.\n ",
"title": "Cors Allowed Methods",
"type": "string"
},
"cors_allowed_headers": {
"default": "*",
"description": "\n A comma-separated list of headers that are authorized to make cross-origin requests to the API.\n\n By default, this is set to `*`, which allows requests from all headers.\n ",
"title": "Cors Allowed Headers",
"type": "string"
}
},
"title": "ServerAPISettings",
"type": "object"
},
"ServerDatabaseSettings": {
"description": "Settings for controlling server database behavior",
"properties": {
"connection_url": {
"anyOf": [
{
"format": "password",
"type": "string",
"writeOnly": true
},
{
"type": "null"
}
],
"default": null,
"description": "\n A database connection URL in a SQLAlchemy-compatible\n format. Prefect currently supports SQLite and Postgres. Note that all\n Prefect database engines must use an async driver - for SQLite, use\n `sqlite+aiosqlite` and for Postgres use `postgresql+asyncpg`.\n\n SQLite in-memory databases can be used by providing the url\n `sqlite+aiosqlite:///file::memory:?cache=shared&uri=true&check_same_thread=false`,\n which will allow the database to be accessed by multiple threads. Note\n that in-memory databases can not be accessed from multiple processes and\n should only be used for simple tests.\n ",
"title": "Connection Url"
},
"driver": {
"anyOf": [
{
"enum": [
"postgresql+asyncpg",
"sqlite+aiosqlite"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The database driver to use when connecting to the database. If not set, the driver will be inferred from the connection URL.",
"title": "Driver"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The database server host.",
"title": "Host"
},
"port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "The database server port.",
"title": "Port"
},
"user": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The user to use when connecting to the database.",
"title": "User"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the Prefect database on the remote server, or the path to the database file for SQLite.",
"title": "Name"
},
"password": {
"anyOf": [
{
"format": "password",
"type": "string",
"writeOnly": true
},
{
"type": "null"
}
],
"default": null,
"description": "The password to use when connecting to the database. Should be kept secret.",
"title": "Password"
},
"echo": {
"default": false,
"description": "If `True`, SQLAlchemy will log all SQL issued to the database. Defaults to `False`.",
"title": "Echo",
"type": "boolean"
},
"migrate_on_start": {
"default": true,
"description": "If `True`, the database will be migrated on application startup.",
"title": "Migrate On Start",
"type": "boolean"
},
"timeout": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": 10.0,
"description": "A statement timeout, in seconds, applied to all database interactions made by the API. Defaults to 10 seconds.",
"title": "Timeout"
},
"connection_timeout": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": 5,
"description": "A connection timeout, in seconds, applied to database connections. Defaults to `5`.",
"title": "Connection Timeout"
},
"sqlalchemy_pool_size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Controls connection pool size when using a PostgreSQL database with the Prefect API. If not set, the default SQLAlchemy pool size will be used.",
"title": "Sqlalchemy Pool Size"
},
"sqlalchemy_max_overflow": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Controls maximum overflow of the connection pool when using a PostgreSQL database with the Prefect API. If not set, the default SQLAlchemy maximum overflow value will be used.",
"title": "Sqlalchemy Max Overflow"
}
},
"title": "ServerDatabaseSettings",
"type": "object"
},
"ServerDeploymentsSettings": {
"properties": {
"concurrency_slot_wait_seconds": {
"default": 30.0,
"description": "The number of seconds to wait before retrying when a deployment flow run cannot secure a concurrency slot from the server.",
"minimum": 0.0,
"title": "Concurrency Slot Wait Seconds",
"type": "number"
}
},
"title": "ServerDeploymentsSettings",
"type": "object"
},
"ServerEphemeralSettings": {
"description": "Settings for controlling ephemeral server behavior",
"properties": {
"enabled": {
"default": false,
"description": "\n Controls whether or not a subprocess server can be started when no API URL is provided.\n ",
"title": "Enabled",
"type": "boolean"
},
"startup_timeout_seconds": {
"default": 20,
"description": "\n The number of seconds to wait for the server to start when ephemeral mode is enabled.\n Defaults to `10`.\n ",
"title": "Startup Timeout Seconds",
"type": "integer"
}
},
"title": "ServerEphemeralSettings",
"type": "object"
},
"ServerEventsSettings": {
"description": "Settings for controlling behavior of the events subsystem",
"properties": {
"stream_out_enabled": {
"default": true,
"description": "Whether or not to stream events out to the API via websockets.",
"title": "Stream Out Enabled",
"type": "boolean"
},
"related_resource_cache_ttl": {
"default": "PT5M",
"description": "The number of seconds to cache related resources for in the API.",
"format": "duration",
"title": "Related Resource Cache Ttl",
"type": "string"
},
"maximum_labels_per_resource": {
"default": 500,
"description": "The maximum number of labels a resource may have.",
"title": "Maximum Labels Per Resource",
"type": "integer"
},
"maximum_related_resources": {
"default": 500,
"description": "The maximum number of related resources an Event may have.",
"title": "Maximum Related Resources",
"type": "integer"
},
"maximum_size_bytes": {
"default": 1500000,
"description": "The maximum size of an Event when serialized to JSON",
"title": "Maximum Size Bytes",
"type": "integer"
},
"expired_bucket_buffer": {
"default": "PT1M",
"description": "The amount of time to retain expired automation buckets",
"format": "duration",
"title": "Expired Bucket Buffer",
"type": "string"
},
"proactive_granularity": {
"default": "PT5S",
"description": "How frequently proactive automations are evaluated",
"format": "duration",
"title": "Proactive Granularity",
"type": "string"
},
"retention_period": {
"default": "P7D",
"description": "The amount of time to retain events in the database.",
"format": "duration",
"title": "Retention Period",
"type": "string"
},
"maximum_websocket_backfill": {
"default": "PT15M",
"description": "The maximum range to look back for backfilling events for a websocket subscriber.",
"format": "duration",
"title": "Maximum Websocket Backfill",
"type": "string"
},
"websocket_backfill_page_size": {
"default": 250,
"description": "The page size for the queries to backfill events for websocket subscribers.",
"exclusiveMinimum": 0,
"title": "Websocket Backfill Page Size",
"type": "integer"
},
"messaging_broker": {
"default": "prefect.server.utilities.messaging.memory",
"description": "Which message broker implementation to use for the messaging system, should point to a module that exports a Publisher and Consumer class.",
"title": "Messaging Broker",
"type": "string"
},
"messaging_cache": {
"default": "prefect.server.utilities.messaging.memory",
"description": "Which cache implementation to use for the events system. Should point to a module that exports a Cache class.",
"title": "Messaging Cache",
"type": "string"
}
},
"title": "ServerEventsSettings",
"type": "object"
},
"ServerFlowRunGraphSettings": {
"description": "Settings for controlling behavior of the flow run graph",
"properties": {
"max_nodes": {
"default": 10000,
"description": "The maximum size of a flow run graph on the v2 API",
"title": "Max Nodes",
"type": "integer"
},
"max_artifacts": {
"default": 10000,
"description": "The maximum number of artifacts to show on a flow run graph on the v2 API",
"title": "Max Artifacts",
"type": "integer"
}
},
"title": "ServerFlowRunGraphSettings",
"type": "object"
},
"ServerServicesCancellationCleanupSettings": {
"description": "Settings for controlling the cancellation cleanup service",
"properties": {
"enabled": {
"default": true,
"description": "Whether or not to start the cancellation cleanup service in the server application.",
"title": "Enabled",
"type": "boolean"
},
"loop_seconds": {
"default": 20,
"description": "The cancellation cleanup service will look for non-terminal tasks and subflows this often. Defaults to `20`.",
"title": "Loop Seconds",
"type": "number"
}
},
"title": "ServerServicesCancellationCleanupSettings",
"type": "object"
},
"ServerServicesEventPersisterSettings": {
"description": "Settings for controlling the event persister service",
"properties": {
"enabled": {
"default": true,
"description": "Whether or not to start the event persister service in the server application.",
"title": "Enabled",
"type": "boolean"
},
"batch_size": {
"default": 20,
"description": "The number of events the event persister will attempt to insert in one batch.",
"exclusiveMinimum": 0,
"title": "Batch Size",
"type": "integer"
},
"flush_interval": {
"default": 5,
"description": "The maximum number of seconds between flushes of the event persister.",
"exclusiveMinimum": 0.0,
"title": "Flush Interval",
"type": "number"
}
},
"title": "ServerServicesEventPersisterSettings",
"type": "object"
},
"ServerServicesFlowRunNotificationsSettings": {
"description": "Settings for controlling the flow run notifications service",
"properties": {
"enabled": {
"default": true,
"description": "Whether or not to start the flow run notifications service in the server application.",
"title": "Enabled",
"type": "boolean"
}
},
"title": "ServerServicesFlowRunNotificationsSettings",
"type": "object"
},
"ServerServicesForemanSettings": {
"description": "Settings for controlling the foreman service",
"properties": {
"enabled": {
"default": true,
"description": "Whether or not to start the foreman service in the server application.",
"title": "Enabled",
"type": "boolean"
},
"loop_seconds": {
"default": 15,
"description": "The foreman service will check for offline workers this often. Defaults to `15`.",
"title": "Loop Seconds",
"type": "number"
},
"inactivity_heartbeat_multiple": {
"default": 3,
"description": "\n The number of heartbeats that must be missed before a worker is marked as offline. Defaults to `3`.\n ",
"title": "Inactivity Heartbeat Multiple",
"type": "integer"
},
"fallback_heartbeat_interval_seconds": {
"default": 30,
"description": "\n The number of seconds to use for online/offline evaluation if a worker's heartbeat\n interval is not set. Defaults to `30`.\n ",
"title": "Fallback Heartbeat Interval Seconds",
"type": "integer"
},
"deployment_last_polled_timeout_seconds": {
"default": 60,
"description": "\n The number of seconds before a deployment is marked as not ready if it has not been\n polled. Defaults to `60`.\n ",
"title": "Deployment Last Polled Timeout Seconds",
"type": "integer"
},
"work_queue_last_polled_timeout_seconds": {
"default": 60,
"description": "\n The number of seconds before a work queue is marked as not ready if it has not been\n polled. Defaults to `60`.\n ",
"title": "Work Queue Last Polled Timeout Seconds",
"type": "integer"
}
},
"title": "ServerServicesForemanSettings",
"type": "object"
},
"ServerServicesLateRunsSettings": {
"description": "Settings for controlling the late runs service",
"properties": {