-
Notifications
You must be signed in to change notification settings - Fork 5
/
config.schema.yml
144 lines (144 loc) · 3.85 KB
/
config.schema.yml
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
$schema: https://json-schema.org/draft/2020-12/schema
$id: https://ocr-d.de/spec/web-api/config.schema.yml
description: Schema for the Processing Broker configuration file
type: object
additionalProperties: false
required:
- process_queue
properties:
process_queue:
description: Information about the Message Queue
type: object
additionalProperties: false
required:
- address
- port
properties:
address:
description: The IP address or domain name of the machine where the Message Queue is deployed
$ref: "#/$defs/address"
port:
description: The port number of the Message Queue
$ref: "#/$defs/port"
credentials:
description: The credentials for the Message Queue
$ref: "#/$defs/credentials"
ssh:
description: Information required for an SSH connection
$ref: "#/$defs/ssh"
database:
description: Information about the MongoDB
type: object
additionalProperties: false
required:
- address
- port
properties:
address:
description: The IP address or domain name of the machine where MongoDB is deployed
$ref: "#/$defs/address"
port:
description: The port number of the MongoDB
$ref: "#/$defs/port"
credentials:
description: The credentials for the MongoDB
$ref: "#/$defs/credentials"
ssh:
description: Information required for an SSH connection
$ref: "#/$defs/ssh"
hosts:
description: A list of hosts where Processing Servers will be deployed
type: array
minItems: 1
items:
description: A host where one or many Processing Servers will be deployed
type: object
additionalProperties: false
required:
- address
- username
- workers
oneOf:
- required:
- password
- required:
- path_to_privkey
properties:
address:
description: The IP address or domain name of the target machine
$ref: "#/$defs/address"
username:
type: string
password:
type: string
path_to_privkey:
description: Path to private key file
type: string
workers:
description: List of workers which will be deployed
type: array
minItems: 1
items:
type: object
additionalProperties: false
required:
- name
properties:
name:
description: Name of the processor
type: string
pattern: "^ocrd-.*$"
examples:
- ocrd-cis-ocropy-binarize
- ocrd-olena-binarize
number_of_instance:
description: Number of instances to be deployed
type: integer
minimum: 1
default: 1
deploy_type:
description: Should the processor be deployed natively or with Docker
type: string
enum:
- native
- docker
default: native
$defs:
address:
type: string
anyOf:
- format: hostname
- format: ipv4
port:
type: integer
minimum: 1
maximum: 65535
credentials:
type: object
additionalProperties: false
required:
- username
- password
properties:
username:
type: string
password:
type: string
ssh:
type: object
additionalProperties: false
oneOf:
- required:
- username
- password
- required:
- username
- path_to_privkey
properties:
username:
type: string
password:
type: string
path_to_privkey:
description: Path to private key file
type: string