schema.v4.json 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701
  1. {
  2. "$schema": "https://json-schema.org/draft/2020-12/schema",
  3. "$id": "https://timmoth.github.io/RackPeek/schemas/v4/schema.v4.json",
  4. "title": "RackPeek Infrastructure Specification",
  5. "type": "object",
  6. "additionalProperties": false,
  7. "required": [
  8. "version",
  9. "resources"
  10. ],
  11. "properties": {
  12. "version": {
  13. "type": "integer",
  14. "const": 4
  15. },
  16. "resources": {
  17. "type": "array",
  18. "items": {
  19. "$ref": "#/$defs/resource"
  20. }
  21. },
  22. "connections": {
  23. "type": [
  24. "array",
  25. "null"
  26. ],
  27. "items": {
  28. "$ref": "#/$defs/connection"
  29. }
  30. }
  31. },
  32. "$defs": {
  33. "labels": {
  34. "type": "object",
  35. "additionalProperties": {
  36. "type": "string"
  37. }
  38. },
  39. "runsOn": {
  40. "type": [
  41. "array",
  42. "null"
  43. ],
  44. "items": {
  45. "type": "string",
  46. "minLength": 1
  47. }
  48. },
  49. "resourceBase": {
  50. "type": "object",
  51. "required": [
  52. "kind",
  53. "name"
  54. ],
  55. "properties": {
  56. "kind": {
  57. "type": "string"
  58. },
  59. "name": {
  60. "type": "string",
  61. "minLength": 1
  62. },
  63. "discoveryId": {
  64. "type": [
  65. "string",
  66. "null"
  67. ],
  68. "description": "Stable machine-generated identity set by 'rpk discover'. Absent on hand-written resources. The leading rpk<n> is the format version, so the way the id is derived can change without old ids being mistaken for new ones.",
  69. "pattern": "^rpk[0-9]+:[a-z0-9]+:[0-9a-f]{16}$"
  70. },
  71. "tags": {
  72. "type": "array",
  73. "items": {
  74. "type": "string"
  75. },
  76. "default": []
  77. },
  78. "labels": {
  79. "$ref": "#/$defs/labels",
  80. "default": {}
  81. },
  82. "notes": {
  83. "type": [
  84. "string",
  85. "null"
  86. ]
  87. },
  88. "runsOn": {
  89. "$ref": "#/$defs/runsOn"
  90. }
  91. }
  92. },
  93. "resource": {
  94. "oneOf": [
  95. {
  96. "$ref": "#/$defs/server"
  97. },
  98. {
  99. "$ref": "#/$defs/firewall"
  100. },
  101. {
  102. "$ref": "#/$defs/router"
  103. },
  104. {
  105. "$ref": "#/$defs/switch"
  106. },
  107. {
  108. "$ref": "#/$defs/accessPoint"
  109. },
  110. {
  111. "$ref": "#/$defs/ups"
  112. },
  113. {
  114. "$ref": "#/$defs/other"
  115. },
  116. {
  117. "$ref": "#/$defs/desktop"
  118. },
  119. {
  120. "$ref": "#/$defs/laptop"
  121. },
  122. {
  123. "$ref": "#/$defs/service"
  124. },
  125. {
  126. "$ref": "#/$defs/system"
  127. }
  128. ]
  129. },
  130. "portReference": {
  131. "type": "object",
  132. "required": [
  133. "resource",
  134. "portGroup",
  135. "portIndex"
  136. ],
  137. "additionalProperties": false,
  138. "properties": {
  139. "resource": {
  140. "type": "string",
  141. "minLength": 1
  142. },
  143. "portGroup": {
  144. "type": "integer",
  145. "minimum": 0
  146. },
  147. "portIndex": {
  148. "type": "integer",
  149. "minimum": 0
  150. }
  151. }
  152. },
  153. "connection": {
  154. "type": "object",
  155. "required": [
  156. "a",
  157. "b"
  158. ],
  159. "additionalProperties": false,
  160. "properties": {
  161. "a": {
  162. "$ref": "#/$defs/portReference"
  163. },
  164. "b": {
  165. "$ref": "#/$defs/portReference"
  166. },
  167. "label": {
  168. "type": [
  169. "string",
  170. "null"
  171. ]
  172. },
  173. "notes": {
  174. "type": [
  175. "string",
  176. "null"
  177. ]
  178. }
  179. }
  180. },
  181. "ram": {
  182. "type": "object",
  183. "required": [
  184. "size"
  185. ],
  186. "additionalProperties": false,
  187. "properties": {
  188. "size": {
  189. "type": "number",
  190. "minimum": 0
  191. },
  192. "mts": {
  193. "type": "integer",
  194. "minimum": 0
  195. }
  196. }
  197. },
  198. "cpu": {
  199. "type": "object",
  200. "additionalProperties": false,
  201. "properties": {
  202. "model": {
  203. "type": "string"
  204. },
  205. "cores": {
  206. "type": "integer",
  207. "minimum": 1
  208. },
  209. "threads": {
  210. "type": "integer",
  211. "minimum": 1
  212. }
  213. }
  214. },
  215. "drive": {
  216. "type": "object",
  217. "required": [
  218. "size"
  219. ],
  220. "additionalProperties": false,
  221. "properties": {
  222. "type": {
  223. "type": "string",
  224. "enum": [
  225. "nvme",
  226. "ssd",
  227. "hdd",
  228. "sas",
  229. "sata",
  230. "usb",
  231. "sdcard",
  232. "micro-sd"
  233. ]
  234. },
  235. "size": {
  236. "type": "number",
  237. "minimum": 1
  238. }
  239. }
  240. },
  241. "gpu": {
  242. "type": "object",
  243. "additionalProperties": false,
  244. "properties": {
  245. "model": {
  246. "type": "string"
  247. },
  248. "vram": {
  249. "type": "number",
  250. "minimum": 0
  251. }
  252. }
  253. },
  254. "port": {
  255. "type": "object",
  256. "required": [
  257. "type",
  258. "speed",
  259. "count"
  260. ],
  261. "additionalProperties": false,
  262. "properties": {
  263. "type": {
  264. "type": "string",
  265. "enum": [
  266. "rj45",
  267. "sfp",
  268. "sfp+",
  269. "sfp28",
  270. "sfp56",
  271. "qsfp+",
  272. "qsfp28",
  273. "qsfp56",
  274. "qsfp-dd",
  275. "osfp",
  276. "xfp",
  277. "cx4",
  278. "mgmt"
  279. ]
  280. },
  281. "speed": {
  282. "type": "number",
  283. "minimum": 0
  284. },
  285. "count": {
  286. "type": "integer",
  287. "minimum": 1
  288. }
  289. }
  290. },
  291. "network": {
  292. "type": "object",
  293. "required": [
  294. "ip",
  295. "port",
  296. "protocol"
  297. ],
  298. "additionalProperties": false,
  299. "properties": {
  300. "ip": {
  301. "type": "string",
  302. "pattern": "^(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}$"
  303. },
  304. "port": {
  305. "type": "integer",
  306. "minimum": 1,
  307. "maximum": 65535
  308. },
  309. "protocol": {
  310. "type": "string",
  311. "enum": [
  312. "TCP",
  313. "UDP"
  314. ]
  315. },
  316. "url": {
  317. "type": "string",
  318. "format": "uri"
  319. }
  320. }
  321. },
  322. "server": {
  323. "allOf": [
  324. {
  325. "$ref": "#/$defs/resourceBase"
  326. },
  327. {
  328. "type": "object",
  329. "properties": {
  330. "kind": {
  331. "const": "Server"
  332. },
  333. "ram": {
  334. "$ref": "#/$defs/ram"
  335. },
  336. "ipmi": {
  337. "type": "boolean"
  338. },
  339. "cpus": {
  340. "type": "array",
  341. "items": {
  342. "$ref": "#/$defs/cpu"
  343. }
  344. },
  345. "drives": {
  346. "type": "array",
  347. "items": {
  348. "$ref": "#/$defs/drive"
  349. }
  350. },
  351. "gpus": {
  352. "type": "array",
  353. "items": {
  354. "$ref": "#/$defs/gpu"
  355. }
  356. },
  357. "ports": {
  358. "type": "array",
  359. "items": {
  360. "$ref": "#/$defs/port"
  361. }
  362. }
  363. }
  364. }
  365. ],
  366. "unevaluatedProperties": false
  367. },
  368. "desktop": {
  369. "allOf": [
  370. {
  371. "$ref": "#/$defs/resourceBase"
  372. },
  373. {
  374. "type": "object",
  375. "properties": {
  376. "kind": {
  377. "const": "Desktop"
  378. },
  379. "ram": {
  380. "$ref": "#/$defs/ram"
  381. },
  382. "cpus": {
  383. "type": "array",
  384. "items": {
  385. "$ref": "#/$defs/cpu"
  386. }
  387. },
  388. "drives": {
  389. "type": "array",
  390. "items": {
  391. "$ref": "#/$defs/drive"
  392. }
  393. },
  394. "gpus": {
  395. "type": "array",
  396. "items": {
  397. "$ref": "#/$defs/gpu"
  398. }
  399. },
  400. "ports": {
  401. "type": "array",
  402. "items": {
  403. "$ref": "#/$defs/port"
  404. }
  405. }
  406. }
  407. }
  408. ],
  409. "unevaluatedProperties": false
  410. },
  411. "laptop": {
  412. "allOf": [
  413. {
  414. "$ref": "#/$defs/resourceBase"
  415. },
  416. {
  417. "type": "object",
  418. "properties": {
  419. "kind": {
  420. "const": "Laptop"
  421. },
  422. "ram": {
  423. "$ref": "#/$defs/ram"
  424. },
  425. "cpus": {
  426. "type": "array",
  427. "items": {
  428. "$ref": "#/$defs/cpu"
  429. }
  430. },
  431. "drives": {
  432. "type": "array",
  433. "items": {
  434. "$ref": "#/$defs/drive"
  435. }
  436. }
  437. }
  438. }
  439. ],
  440. "unevaluatedProperties": false
  441. },
  442. "firewall": {
  443. "allOf": [
  444. {
  445. "$ref": "#/$defs/resourceBase"
  446. },
  447. {
  448. "type": "object",
  449. "required": [
  450. "ports"
  451. ],
  452. "properties": {
  453. "kind": {
  454. "const": "Firewall"
  455. },
  456. "model": {
  457. "type": "string"
  458. },
  459. "managed": {
  460. "type": "boolean"
  461. },
  462. "poe": {
  463. "type": "boolean"
  464. },
  465. "ports": {
  466. "type": "array",
  467. "items": {
  468. "$ref": "#/$defs/port"
  469. }
  470. }
  471. }
  472. }
  473. ],
  474. "unevaluatedProperties": false
  475. },
  476. "router": {
  477. "allOf": [
  478. {
  479. "$ref": "#/$defs/resourceBase"
  480. },
  481. {
  482. "type": "object",
  483. "required": [
  484. "ports"
  485. ],
  486. "properties": {
  487. "kind": {
  488. "const": "Router"
  489. },
  490. "model": {
  491. "type": "string"
  492. },
  493. "managed": {
  494. "type": "boolean"
  495. },
  496. "poe": {
  497. "type": "boolean"
  498. },
  499. "ports": {
  500. "type": "array",
  501. "items": {
  502. "$ref": "#/$defs/port"
  503. }
  504. }
  505. }
  506. }
  507. ],
  508. "unevaluatedProperties": false
  509. },
  510. "switch": {
  511. "allOf": [
  512. {
  513. "$ref": "#/$defs/resourceBase"
  514. },
  515. {
  516. "type": "object",
  517. "required": [
  518. "ports"
  519. ],
  520. "properties": {
  521. "kind": {
  522. "const": "Switch"
  523. },
  524. "model": {
  525. "type": "string"
  526. },
  527. "managed": {
  528. "type": "boolean"
  529. },
  530. "poe": {
  531. "type": "boolean"
  532. },
  533. "ports": {
  534. "type": "array",
  535. "items": {
  536. "$ref": "#/$defs/port"
  537. }
  538. }
  539. }
  540. }
  541. ],
  542. "unevaluatedProperties": false
  543. },
  544. "accessPoint": {
  545. "allOf": [
  546. {
  547. "$ref": "#/$defs/resourceBase"
  548. },
  549. {
  550. "type": "object",
  551. "properties": {
  552. "kind": {
  553. "const": "AccessPoint"
  554. },
  555. "model": {
  556. "type": "string"
  557. },
  558. "speed": {
  559. "type": "number",
  560. "minimum": 0
  561. },
  562. "ports": {
  563. "type": "array",
  564. "items": {
  565. "$ref": "#/$defs/port"
  566. }
  567. }
  568. }
  569. }
  570. ],
  571. "unevaluatedProperties": false
  572. },
  573. "ups": {
  574. "allOf": [
  575. {
  576. "$ref": "#/$defs/resourceBase"
  577. },
  578. {
  579. "type": "object",
  580. "properties": {
  581. "kind": {
  582. "const": "Ups"
  583. },
  584. "model": {
  585. "type": "string"
  586. },
  587. "va": {
  588. "type": "integer",
  589. "minimum": 1
  590. }
  591. }
  592. }
  593. ],
  594. "unevaluatedProperties": false
  595. },
  596. "other": {
  597. "allOf": [
  598. {
  599. "$ref": "#/$defs/resourceBase"
  600. },
  601. {
  602. "type": "object",
  603. "properties": {
  604. "kind": {
  605. "const": "Other"
  606. },
  607. "model": {
  608. "type": "string"
  609. },
  610. "description": {
  611. "type": "string"
  612. }
  613. }
  614. }
  615. ],
  616. "unevaluatedProperties": false
  617. },
  618. "service": {
  619. "allOf": [
  620. {
  621. "$ref": "#/$defs/resourceBase"
  622. },
  623. {
  624. "type": "object",
  625. "required": [
  626. "network"
  627. ],
  628. "properties": {
  629. "kind": {
  630. "const": "Service"
  631. },
  632. "network": {
  633. "$ref": "#/$defs/network"
  634. }
  635. }
  636. }
  637. ],
  638. "unevaluatedProperties": false
  639. },
  640. "system": {
  641. "allOf": [
  642. {
  643. "$ref": "#/$defs/resourceBase"
  644. },
  645. {
  646. "type": "object",
  647. "required": [
  648. "type",
  649. "os",
  650. "cores",
  651. "ram"
  652. ],
  653. "properties": {
  654. "kind": {
  655. "const": "System"
  656. },
  657. "type": {
  658. "type": "string",
  659. "enum": [
  660. "baremetal",
  661. "Baremetal",
  662. "cluster",
  663. "Cluster",
  664. "hypervisor",
  665. "Hypervisor",
  666. "vm",
  667. "VM",
  668. "container",
  669. "embedded",
  670. "cloud",
  671. "other"
  672. ]
  673. },
  674. "ip": {
  675. "type": "string",
  676. "pattern": "^(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}$"
  677. },
  678. "os": {
  679. "type": "string"
  680. },
  681. "cores": {
  682. "type": "integer",
  683. "minimum": 1
  684. },
  685. "ram": {
  686. "type": "number",
  687. "minimum": 0
  688. },
  689. "drives": {
  690. "type": "array",
  691. "items": {
  692. "$ref": "#/$defs/drive"
  693. }
  694. }
  695. }
  696. }
  697. ],
  698. "unevaluatedProperties": false
  699. }
  700. }
  701. }