Skip to content

Commit ff0fc66

Browse files
wkingparavmellanox
wking
authored and
paravmellanox
committed
schema: Completely drop our JSON Schema 'id' properties
We're using JSON Schema draft-04 [1], as declared by our '$schema' properties [2]. In draft-04, the 'id' keyword alters the resolution scope. But our current '$ref' values use JSON Pointers [3,4] with relative references like 'defs-linux.json#/definitions/Device' that ignore the 'id's. By draft-07, 'id' has become '$id', and [5]: The root schema of a JSON Schema document SHOULD contain an "$id" keyword with a URI (containing a scheme). But since [6], including any URI that cannot be retrieved generates an error: $ ./validate config-schema.json test/config/good/minimal.json Could not read schema from HTTP, response status is 404 Not Found While a root 'id' entry would be nice, we don't currently host these anywhere with a useful URI. We could use [7], but then testing pull requests would be difficult. By draft-07, the purpose of internal '$id' entries is clearly explained [5]: Providing a plain name fragment enables a subschema to be relocated within a schema without requiring that JSON Pointer references are updated. We don't need that, because we control all the references. In the infrequent event of a subschema move, we can update the consuming references in the same commit. The draft-07 $ref docs also explain that $ref targets may be URNs [8]: The URI is not a network locator, only an identifier. A schema need not be downloadable from the address if it is a network-addressable URL, and implementations SHOULD NOT assume they should perform a network operation when they encounter a network-addressable URI. I haven't found analogous wording for $id, but it's possible that gojsonschema is being overly agressive with its attempted retrievals. This commit removes all of our 'id' entries. The resulting JSON Schema is valid (regardless of where you host it) and does not generate the 404s. Reported by Tom Godkin [9] and William Martin [10]. [1]: https://tools.ietf.org/html/draft-zyp-json-schema-04#section-7.2 [2]: https://tools.ietf.org/html/draft-zyp-json-schema-04#section-6 [3]: https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-07 [4]: https://tools.ietf.org/html/rfc6901 [5]: https://tools.ietf.org/html/draft-handrews-json-schema-00#section-9.2 [6]: xeipuuv/gojsonschema@83a7f63 [7]: https://raw.githubusercontent.com/opencontainers/runtime-spec/v1.0.1/schema/config-schema.json [8]: https://tools.ietf.org/html/draft-handrews-json-schema-00#section-8 [9]: opencontainers/runc#1680 [10]: https://groups.google.com/a/opencontainers.org/forum/#!topic/dev/L9ME-YRPmmc Subject: runtime-spec validation questions Date: Thu, 4 Jan 2018 15:47:50 +0000 Message-ID: <CAMp6QwMTJab5K25=CVy=6OZV6NRX0s-nMLGwqC8ZMpFEp5bF_Q@mail.gmail.com> Signed-off-by: W. Trevor King <[email protected]>
1 parent 9c166f2 commit ff0fc66

File tree

5 files changed

+0
-124
lines changed

5 files changed

+0
-124
lines changed

‎schema/config-linux.json‎

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,27 @@
11
{
22
"linux": {
33
"description": "Linux platform-specific configurations",
4-
"id": "https://opencontainers.org/schema/bundle/linux",
54
"type": "object",
65
"properties": {
76
"devices": {
8-
"id": "https://opencontainers.org/schema/bundle/linux/devices",
97
"type": "array",
108
"items": {
119
"$ref": "defs-linux.json#/definitions/Device"
1210
}
1311
},
1412
"uidMappings": {
15-
"id": "https://opencontainers.org/schema/bundle/linux/uidMappings",
1613
"type": "array",
1714
"items": {
1815
"$ref": "defs.json#/definitions/IDMapping"
1916
}
2017
},
2118
"gidMappings": {
22-
"id": "https://opencontainers.org/schema/bundle/linux/gidMappings",
2319
"type": "array",
2420
"items": {
2521
"$ref": "defs.json#/definitions/IDMapping"
2622
}
2723
},
2824
"namespaces": {
29-
"id": "https://opencontainers.org/schema/bundle/linux/namespaces",
3025
"type": "array",
3126
"items": {
3227
"anyOf": [
@@ -37,22 +32,18 @@
3732
}
3833
},
3934
"resources": {
40-
"id": "https://opencontainers.org/schema/bundle/linux/resources",
4135
"type": "object",
4236
"properties": {
4337
"devices": {
44-
"id": "https://opencontainers.org/schema/bundle/linux/resources/devices",
4538
"type": "array",
4639
"items": {
4740
"$ref": "defs-linux.json#/definitions/DeviceCgroup"
4841
}
4942
},
5043
"pids": {
51-
"id": "https://opencontainers.org/schema/bundle/linux/resources/pids",
5244
"type": "object",
5345
"properties": {
5446
"limit": {
55-
"id": "https://opencontainers.org/schema/bundle/linux/resources/pids/limit",
5647
"$ref": "defs.json#/definitions/int64"
5748
}
5849
},
@@ -61,47 +52,39 @@
6152
]
6253
},
6354
"blockIO": {
64-
"id": "https://opencontainers.org/schema/bundle/linux/resources/blockIO",
6555
"type": "object",
6656
"properties": {
6757
"weight": {
68-
"id": "https://opencontainers.org/schema/bundle/linux/resources/blockIO/weight",
6958
"$ref": "defs-linux.json#/definitions/weight"
7059
},
7160
"leafWeight": {
72-
"id": "https://opencontainers.org/schema/bundle/linux/resources/blockIO/leafWeight",
7361
"$ref": "defs-linux.json#/definitions/weight"
7462
},
7563
"throttleReadBpsDevice": {
76-
"id": "https://opencontainers.org/schema/bundle/linux/resources/blockIO/throttleReadBpsDevice",
7764
"type": "array",
7865
"items": {
7966
"$ref": "defs-linux.json#/definitions/blockIODeviceThrottle"
8067
}
8168
},
8269
"throttleWriteBpsDevice": {
83-
"id": "https://opencontainers.org/schema/bundle/linux/resources/blockIO/throttleWriteBpsDevice",
8470
"type": "array",
8571
"items": {
8672
"$ref": "defs-linux.json#/definitions/blockIODeviceThrottle"
8773
}
8874
},
8975
"throttleReadIOPSDevice": {
90-
"id": "https://opencontainers.org/schema/bundle/linux/resources/blockIO/throttleReadIOPSDevice",
9176
"type": "array",
9277
"items": {
9378
"$ref": "defs-linux.json#/definitions/blockIODeviceThrottle"
9479
}
9580
},
9681
"throttleWriteIOPSDevice": {
97-
"id": "https://opencontainers.org/schema/bundle/linux/resources/blockIO/throttleWriteIOPSDevice",
9882
"type": "array",
9983
"items": {
10084
"$ref": "defs-linux.json#/definitions/blockIODeviceThrottle"
10185
}
10286
},
10387
"weightDevice": {
104-
"id": "https://opencontainers.org/schema/bundle/linux/resources/blockIO/weightDevice",
10588
"type": "array",
10689
"items": {
10790
"$ref": "defs-linux.json#/definitions/blockIODeviceWeight"
@@ -110,41 +93,32 @@
11093
}
11194
},
11295
"cpu": {
113-
"id": "https://opencontainers.org/schema/bundle/linux/resources/cpu",
11496
"type": "object",
11597
"properties": {
11698
"cpus": {
117-
"id": "https://opencontainers.org/schema/bundle/linux/resources/cpu/cpus",
11899
"type": "string"
119100
},
120101
"mems": {
121-
"id": "https://opencontainers.org/schema/bundle/linux/resources/cpu/mems",
122102
"type": "string"
123103
},
124104
"period": {
125-
"id": "https://opencontainers.org/schema/bundle/linux/resources/cpu/period",
126105
"$ref": "defs.json#/definitions/uint64"
127106
},
128107
"quota": {
129-
"id": "https://opencontainers.org/schema/bundle/linux/resources/cpu/quota",
130108
"$ref": "defs.json#/definitions/int64"
131109
},
132110
"realtimePeriod": {
133-
"id": "https://opencontainers.org/schema/bundle/linux/resources/cpu/realtimePeriod",
134111
"$ref": "defs.json#/definitions/uint64"
135112
},
136113
"realtimeRuntime": {
137-
"id": "https://opencontainers.org/schema/bundle/linux/resources/cpu/realtimeRuntime",
138114
"$ref": "defs.json#/definitions/int64"
139115
},
140116
"shares": {
141-
"id": "https://opencontainers.org/schema/bundle/linux/resources/cpu/shares",
142117
"$ref": "defs.json#/definitions/uint64"
143118
}
144119
}
145120
},
146121
"hugepageLimits": {
147-
"id": "https://opencontainers.org/schema/bundle/linux/resources/hugepageLimits",
148122
"type": "array",
149123
"items": {
150124
"type": "object",
@@ -163,49 +137,38 @@
163137
}
164138
},
165139
"memory": {
166-
"id": "https://opencontainers.org/schema/bundle/linux/resources/memory",
167140
"type": "object",
168141
"properties": {
169142
"kernel": {
170-
"id": "https://opencontainers.org/schema/bundle/linux/resources/memory/kernel",
171143
"$ref": "defs.json#/definitions/int64"
172144
},
173145
"kernelTCP": {
174-
"id": "https://opencontainers.org/schema/bundle/linux/resources/memory/kernelTCP",
175146
"$ref": "defs.json#/definitions/int64"
176147
},
177148
"limit": {
178-
"id": "https://opencontainers.org/schema/bundle/linux/resources/memory/limit",
179149
"$ref": "defs.json#/definitions/int64"
180150
},
181151
"reservation": {
182-
"id": "https://opencontainers.org/schema/bundle/linux/resources/memory/reservation",
183152
"$ref": "defs.json#/definitions/int64"
184153
},
185154
"swap": {
186-
"id": "https://opencontainers.org/schema/bundle/linux/resources/memory/swap",
187155
"$ref": "defs.json#/definitions/int64"
188156
},
189157
"swappiness": {
190-
"id": "https://opencontainers.org/schema/bundle/linux/resources/memory/swappiness",
191158
"$ref": "defs.json#/definitions/uint64"
192159
},
193160
"disableOOMKiller": {
194-
"id": "https://opencontainers.org/schema/bundle/linux/resources/memory/disableOOMKiller",
195161
"type": "boolean"
196162
}
197163
}
198164
},
199165
"network": {
200-
"id": "https://opencontainers.org/schema/bundle/linux/resources/network",
201166
"type": "object",
202167
"properties": {
203168
"classID": {
204-
"id": "https://opencontainers.org/schema/bundle/linux/resources/network/classId",
205169
"$ref": "defs.json#/definitions/uint32"
206170
},
207171
"priorities": {
208-
"id": "https://opencontainers.org/schema/bundle/linux/resources/network/priorities",
209172
"type": "array",
210173
"items": {
211174
"$ref": "defs-linux.json#/definitions/NetworkInterfacePriority"
@@ -222,30 +185,24 @@
222185
}
223186
},
224187
"cgroupsPath": {
225-
"id": "https://opencontainers.org/schema/bundle/linux/cgroupsPath",
226188
"type": "string"
227189
},
228190
"rootfsPropagation": {
229-
"id": "https://opencontainers.org/schema/bundle/linux/rootfsPropagation",
230191
"$ref": "defs-linux.json#/definitions/RootfsPropagation"
231192
},
232193
"seccomp": {
233-
"id": "https://opencontainers.org/schema/bundle/linux/seccomp",
234194
"type": "object",
235195
"properties": {
236196
"defaultAction": {
237-
"id": "https://opencontainers.org/schema/bundle/linux/seccomp/defaultAction",
238197
"$ref": "defs-linux.json#/definitions/SeccompAction"
239198
},
240199
"architectures": {
241-
"id": "https://opencontainers.org/schema/bundle/linux/seccomp/architectures",
242200
"type": "array",
243201
"items": {
244202
"$ref": "defs-linux.json#/definitions/SeccompArch"
245203
}
246204
},
247205
"syscalls": {
248-
"id": "https://opencontainers.org/schema/bundle/linux/seccomp/syscalls",
249206
"type": "array",
250207
"items": {
251208
"$ref": "defs-linux.json#/definitions/Syscall"
@@ -257,27 +214,21 @@
257214
]
258215
},
259216
"sysctl": {
260-
"id": "https://opencontainers.org/schema/bundle/linux/sysctl",
261217
"$ref": "defs.json#/definitions/mapStringString"
262218
},
263219
"maskedPaths": {
264-
"id": "https://opencontainers.org/schema/bundle/linux/maskedPaths",
265220
"$ref": "defs.json#/definitions/ArrayOfStrings"
266221
},
267222
"readonlyPaths": {
268-
"id": "https://opencontainers.org/schema/bundle/linux/readonlyPaths",
269223
"$ref": "defs.json#/definitions/ArrayOfStrings"
270224
},
271225
"mountLabel": {
272-
"id": "https://opencontainers.org/schema/bundle/linux/mountLabel",
273226
"type": "string"
274227
},
275228
"intelRdt": {
276-
"id": "https://opencontainers.org/schema/bundle/linux/intelRdt",
277229
"type": "object",
278230
"properties": {
279231
"l3CacheSchema": {
280-
"id": "https://opencontainers.org/schema/bundle/linux/intelRdt/l3CacheSchema",
281232
"type": "string"
282233
}
283234
}

0 commit comments

Comments
 (0)