pattern-ui-catalog/pattern.schema.json at main · validatedpatterns/pattern-ui-catalog · 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
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://validatedpatterns.io/pattern.schema.json",
  "title": "Validated Pattern Metadata",
  "description": "Schema for validated pattern metadata files (pattern.yaml)",
  "type": "object",
  "required": [
    "metadata_version",
    "name",
    "pattern_version",
    "display_name",
    "repo_url",
    "docs_repo_url",
    "issues_url",
    "docs_url",
    "ci_url",
    "tier",
    "owners",
    "requirements",
    "extra_features",
    "org"
  ],
  "additionalProperties": false,
  "properties": {
    "metadata_version": {
      "type": "string",
      "description": "Version of the metadata format",
      "pattern": "^[0-9]+\\.[0-9]+$"
    },
    "name": {
      "type": "string",
      "description": "Unique identifier for the pattern",
      "pattern": "^[a-z][a-z0-9-]*$"
    },
    "description": {
      "type": "string",
      "description": "A short description of the pattern"
    },
    "pattern_version": {
      "type": "string",
      "description": "Version of the pattern",
      "pattern": "^[0-9]+\\.[0-9]+$"
    },
    "display_name": {
      "type": "string",
      "description": "Human-readable display name"
    },
    "repo_url": {
      "type": "string",
      "description": "URL to the pattern repository",
      "format": "uri"
    },
    "docs_repo_url": {
      "type": "string",
      "description": "URL to the documentation repository",
      "format": "uri"
    },
    "issues_url": {
      "type": "string",
      "description": "URL to the issue tracker",
      "format": "uri"
    },
    "docs_url": {
      "type": "string",
      "description": "URL to the pattern documentation",
      "format": "uri"
    },
    "ci_url": {
      "type": "string",
      "description": "URL to the CI/CD pipeline",
      "format": "uri"
    },
    "tier": {
      "type": "string",
      "description": "Support tier for the pattern",
      "enum": ["maintained", "tested", "sandbox"]
    },
    "owners": {
      "type": "array",
      "description": "List of pattern owners (GitHub usernames)",
      "items": {
        "type": "string"
      },
      "minItems": 1
    },
    "requirements": {
      "type": "object",
      "description": "Infrastructure requirements for the pattern",
      "required": ["hub"],
      "additionalProperties": false,
      "properties": {
        "hub": {
          "$ref": "#/$defs/clusterRequirements"
        },
        "spoke": {
          "$ref": "#/$defs/clusterRequirements"
        }
      }
    },
    "extra_features": {
      "type": "object",
      "description": "Additional feature flags",
      "required": ["hypershift_support", "spoke_support"],
      "additionalProperties": false,
      "properties": {
        "hypershift_support": {
          "type": "boolean"
        },
        "spoke_support": {
          "type": "boolean"
        }
      }
    },
    "external_requirements": {
      "description": "Additional external requirements or null",
      "oneOf": [
        { "type": "null" },
        {
          "type": "object",
          "properties": {
            "cluster_sizing_note": {
              "type": "string",
              "description": "Additional notes about cluster sizing"
            }
          },
          "additionalProperties": true
        }
      ]
    },
    "org": {
      "type": "string",
      "description": "GitHub organization name"
    },
    "spoke": {
      "description": "Spoke configuration (reserved for future use)",
      "type": "null"
    },
    "clustergroupname": {
      "type": "string",
      "description": "Default clusterGroupName to use"
    },
    "logo": {
      "type": "string",
      "description": "URL or path to a logo image for the pattern",
      "format": "uri"
    },
    "ocp_versions": {
      "$ref": "#/$defs/ocpVersions"
    },
    "variants": {
      "type": "array",
      "description": "Deployment variants for the pattern",
      "items": {
        "$ref": "#/$defs/variant"
      },
      "minItems": 1
    }
  },
  "$defs": {
    "cloudProviderSpec": {
      "type": "object",
      "required": ["replicas", "type"],
      "additionalProperties": false,
      "properties": {
        "replicas": {
          "type": "integer",
          "minimum": 0,
          "description": "Number of replicas"
        },
        "type": {
          "type": "string",
          "description": "Instance/machine type"
        }
      }
    },
    "nodePoolSpec": {
      "type": "object",
      "additionalProperties": false,
      "minProperties": 1,
      "properties": {
        "aws": {
          "$ref": "#/$defs/cloudProviderSpec"
        },
        "gcp": {
          "$ref": "#/$defs/cloudProviderSpec"
        },
        "azure": {
          "$ref": "#/$defs/cloudProviderSpec"
        }
      }
    },
    "clusterRequirements": {
      "type": "object",
      "description": "Requirements for a cluster (hub or spoke)",
      "required": ["compute", "controlPlane"],
      "additionalProperties": false,
      "properties": {
        "compute": {
          "$ref": "#/$defs/nodePoolSpec"
        },
        "controlPlane": {
          "$ref": "#/$defs/nodePoolSpec"
        }
      }
    },
    "variant": {
      "type": "object",
      "description": "A deployment variant of the pattern",
      "required": ["name"],
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "description": "Unique identifier for the variant"
        },
        "default": {
          "type": "boolean",
          "description": "Whether this is the default variant"
        },
        "description": {
          "type": "string",
          "description": "Human-readable description of the variant"
        }
      }
    },
    "ocpVersions": {
      "type": "object",
      "description": "OCP version compatibility requirements checked by the validate_ocp_version role during installation",
      "additionalProperties": false,
      "properties": {
        "minimum": {
          "type": "string",
          "description": "Minimum supported OCP version (e.g. 4.20). Versions below this trigger a warning.",
          "pattern": "^[0-9]+\\.[0-9]+$"
        },
        "unsupported": {
          "type": "array",
          "description": "Explicitly unsupported OCP versions that cause a hard fail during installation",
          "items": {
            "$ref": "#/$defs/unsupportedOcpVersion"
          }
        }
      }
    },
    "unsupportedOcpVersion": {
      "type": "object",
      "description": "An OCP version that is explicitly not supported",
      "required": ["version", "reason"],
      "additionalProperties": false,
      "properties": {
        "version": {
          "type": "string",
          "description": "OCP version string (e.g. 4.23)",
          "pattern": "^[0-9]+\\.[0-9]+$"
        },
        "reason": {
          "type": "string",
          "description": "Human-readable explanation of why this version is unsupported"
        }
      }
    }
  }
}