datumctl-plugins/schema/plugin-v1alpha1.json at main · datum-cloud/datumctl-plugins · GitHub

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
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Plugin",
  "description": "A datumctl plugin manifest (apiVersion: datumctl.datum.net/v1alpha1, kind: Plugin)",
  "type": "object",
  "required": ["apiVersion", "kind", "metadata", "spec"],
  "properties": {
    "apiVersion": {
      "type": "string",
      "const": "datumctl.datum.net/v1alpha1"
    },
    "kind": {
      "type": "string",
      "const": "Plugin"
    },
    "metadata": {
      "type": "object",
      "required": ["name"],
      "properties": {
        "name": {
          "type": "string",
          "pattern": "^[a-z][a-z0-9-]*$",
          "description": "Short plugin name, e.g. 'compute'. Must be lowercase alphanumeric with hyphens."
        }
      }
    },
    "spec": {
      "type": "object",
      "required": ["shortDescription", "version", "platforms"],
      "properties": {
        "shortDescription": {
          "type": "string",
          "maxLength": 120,
          "description": "One-line summary shown in datumctl plugin search."
        },
        "description": {
          "type": "string",
          "description": "Optional longer help text."
        },
        "homepage": {
          "type": "string",
          "format": "uri"
        },
        "version": {
          "type": "string",
          "pattern": "^v[0-9]+\\.[0-9]+\\.[0-9]",
          "description": "Semantic version string, e.g. v1.2.0"
        },
        "platforms": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "object",
            "required": ["uri", "sha256"],
            "properties": {
              "selector": {
                "type": "object",
                "properties": {
                  "matchLabels": {
                    "type": "object",
                    "properties": {
                      "os": {
                        "type": "string",
                        "enum": ["linux", "darwin", "windows"]
                      },
                      "arch": {
                        "type": "string",
                        "enum": ["amd64", "arm64", "386"]
                      }
                    }
                  }
                }
              },
              "uri": {
                "type": "string",
                "format": "uri"
              },
              "sha256": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$",
                "description": "Lowercase hex SHA256 of the archive at uri."
              },
              "files": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": ["from"],
                  "properties": {
                    "from": { "type": "string" },
                    "to": { "type": "string" }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}