| 1 | { |
| 2 | "$schema": "http://json-schema.org/draft-07/schema#", |
| 3 | "type": "array", |
| 4 | "title": "Netdata deployment information meta.", |
| 5 | "items": { |
| 6 | "type": "object", |
| 7 | "description": "Individual entries for deployment information.", |
| 8 | "properties": { |
| 9 | "id": { |
| 10 | "$ref": "./shared.json#/$defs/id" |
| 11 | }, |
| 12 | "meta": { |
| 13 | "$ref": "./shared.json#/$defs/instance" |
| 14 | }, |
| 15 | "keywords": { |
| 16 | "$ref": "./shared.json#/$defs/keywords" |
| 17 | }, |
| 18 | "install_description": { |
| 19 | "type": "string", |
| 20 | "description": "Describes basic information about how to deploy on this platform." |
| 21 | }, |
| 22 | "methods": { |
| 23 | "type": "array", |
| 24 | "description": "Describes the various ways to deploy on this platform.", |
| 25 | "items": { |
| 26 | "type": "object", |
| 27 | "properties": { |
| 28 | "method": { |
| 29 | "type": "string", |
| 30 | "description": "The name of the installation method." |
| 31 | }, |
| 32 | "commands": { |
| 33 | "type": "array", |
| 34 | "items": { |
| 35 | "type": "object", |
| 36 | "properties": { |
| 37 | "channel": { |
| 38 | "type": "string", |
| 39 | "description": "The release channel that this command is used for.", |
| 40 | "enum": [ |
| 41 | "nightly", |
| 42 | "stable" |
| 43 | ] |
| 44 | }, |
| 45 | "command": { |
| 46 | "type": "string", |
| 47 | "description": "The command to run for installing using this method." |
| 48 | } |
| 49 | }, |
| 50 | "required": [ |
| 51 | "channel", |
| 52 | "command" |
| 53 | ] |
| 54 | } |
| 55 | } |
| 56 | }, |
| 57 | "required": [ |
| 58 | "method", |
| 59 | "commands" |
| 60 | ] |
| 61 | } |
| 62 | }, |
| 63 | "additional_info": { |
| 64 | "type": "string", |
| 65 | "description": "Any additional information about this platform." |
| 66 | }, |
| 67 | "clean_additional_info": { |
| 68 | "type": "string", |
| 69 | "description": "Any additional information about this platform, without any embedded custom tags." |
| 70 | }, |
| 71 | "related_resources": { |
| 72 | "type": "object", |
| 73 | "description": "TBD" |
| 74 | }, |
| 75 | "platform_info": { |
| 76 | "type": "object", |
| 77 | "description": "References what platform this deployment info is for. In the parsed output, this will be replaced with a markdown string covering basic support information for this platform.", |
| 78 | "properties": { |
| 79 | "group": { |
| 80 | "type": "string", |
| 81 | "description": "Identifies the group that the platform is in. 'include' is used for platforms that are in auto-generated CI. 'no_include' is used for platforms that are not in auto-generated CI. An empty string indicates no associated platform information.", |
| 82 | "enum": [ |
| 83 | "include", |
| 84 | "no_include", |
| 85 | "" |
| 86 | ] |
| 87 | }, |
| 88 | "distro": { |
| 89 | "type": "string", |
| 90 | "description": "Identifies the platform within the group, based on the value of the 'distro' key." |
| 91 | } |
| 92 | }, |
| 93 | "required": [ |
| 94 | "group", |
| 95 | "distro" |
| 96 | ] |
| 97 | }, |
| 98 | "quick_start": { |
| 99 | "type": "integer", |
| 100 | "description": "Indicates where the deploy integration should appear in the add nodes dialogue. A value less than 0 indicates that it should not appear on this dialogue." |
| 101 | } |
| 102 | }, |
| 103 | "required": [ |
| 104 | "id", |
| 105 | "meta", |
| 106 | "keywords", |
| 107 | "install_description", |
| 108 | "methods", |
| 109 | "additional_info", |
| 110 | "related_resources", |
| 111 | "platform_info", |
| 112 | "quick_start" |
| 113 | ] |
| 114 | } |
| 115 | } |