summaryrefslogtreecommitdiffstats
path: root/config/pdf/pod1.schema.yaml
blob: 33b2d8c303ba15c95fbbfb205627439ce2bb35b2 (plain)
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
##############################################################################
# Copyright (c) 2018 Enea AB and others.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
---
$schema: 'http://json-schema.org/schema#'
$id: 'https://github.com/opnfv/pharos/blob/master/config/pdf/pod1.yaml'

definitions:
  ############################################################################
  # Low-level, general purpose definitions, unversioned
  ip_address:
    type: 'string'  # NOTE: we don't validate this is a valid addr (yet)
  mac_address:
    type: 'string'
    pattern: '^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$'
  ############################################################################
  # Mid-level definitions, common schema for jumpserver & cluster nodes
  node:
    v1.0:
      type: 'object'
      properties:
        type:
          type: 'string'
          enum: ['baremetal', 'virtual']
        vendor:
          type: 'string'
        model:
          type: 'string'
        arch:
          type: 'string'
          enum: ['aarch64', 'x86_64']
        cpus:
          type: 'number'
        cpu_cflags:
          type: 'string'
        cores:
          type: 'number'
        memory:
          type: 'string'
          pattern: '^[1-9]\d*[MGT]B?$'
      required: ['type', 'vendor', 'model', 'arch', 'cpus', 'cpu_cflags', 'cores', 'memory']
      additionalProperties: false
  disks:
    v1.0:
      type: 'array'
      items:
        type: 'object'
        properties:
          name:
            type: 'string'
            pattern: '^disk[0-9]+$'
          disk_capacity:
            type: 'string'
            pattern: '^[1-9][\d\.]*[MGT]B?$'
          disk_type:
            type: 'string'
            enum: ['hdd', 'ssd', 'cdrom', 'tape']
          disk_interface:
            type: 'string'
            enum: ['sata', 'sas', 'ssd', 'nvme', 'scsi', 'iscsi']
          disk_rotation:
            type: 'number'
            enum: [0, 5400, 7200, 10000, 15000]
        required: ['name', 'disk_capacity', 'disk_type', 'disk_interface', 'disk_rotation']
        additionalProperties: false
  remote_management:
    v1.0:
      properties:
        user:
          type: 'string'
        pass:
          type: 'string'
        type:
          type: 'string'
        versions:
          type: 'array'
        address:
          type: 'string'
        mac_address:
          type: 'string'
      # These subsections are best validated separately for baremetal/virtual
      oneOf:
        - type: 'object'
          properties:
            type:
              type: 'string'
              enum: ['ipmi', 'amt']
            versions:
              type: 'array'
              items:
                type: 'number'
                enum: [1.0, 2.0]
            address:
              $ref: '#/definitions/ip_address'
            mac_address:
              $ref: '#/definitions/mac_address'
          required: ['type', 'versions', 'address', 'mac_address']
        - type: 'object'
          properties:
            type:
              type: 'string'
              enum: ['libvirt']
            address:
              type: 'string'  # Loose validation of libvirt URI for now
          required: ['type', 'address']
      required: ['user', 'pass']
      additionalProperties: false
  interfaces:
    v1.0:
      type: 'array'
      items:
        type: 'object'
        properties:
          name:
            type: 'string'
            pattern: '^nic[0-9]+$'
          mac_address:
            $ref: '#/definitions/mac_address'
          # Optional
          address:
            $ref: '#/definitions/ip_address'
          # Optional
          vlan:
            oneOf:
              - type: 'string'
                pattern: '^(native|[1-9][0-9]{0,3})(\|(native|[1-9][0-9]{0,3}))*$'
              - type: 'integer'
                mininum: 1
                maximum: 4095
          # Optional
          speed:
            type: 'string'
            enum: ['1gb', '10gb', '25gb', '40gb']
            # FIXME: mandatory for nodes?
          # Optional
          features:
            type: ['string', 'null']
            pattern: '^((dpdk|sriov)\|?)*$'
            # FIXME: mandatory for nodes?
        required: ['name', 'mac_address']
        additionalProperties: false
  ############################################################################
  # Top-level PDF blocks, versioned
  details:
    v1.0:
      type: 'object'
      properties:
        type:
          type: 'string'
          enum: ['production', 'development']
        pod_owner:
          type: 'string'
        contact:
          type: 'string'
          pattern: '^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+[,; ]*)+$'
        lab:
          type: 'string'
        location:
          type: 'string'
        link:
          type: 'string'
      required: ['type', 'pod_owner', 'contact', 'lab', 'location', 'link']
      additionalProperties: false
  jumphost:
    v1.0:
      type: 'object'
      properties:
        name:
          type: 'string'
        node:
          $ref: '#/definitions/node/v1.0'
        disks:
          $ref: '#/definitions/disks/v1.0'
        os:
          type: 'string'
        remote_params:  # Optional YAML anchor, contents will be validated below
          type: 'object'
        remote_management:
          $ref: '#/definitions/remote_management/v1.0'
        interfaces:
          $ref: '#/definitions/interfaces/v1.0'
      required: ['name', 'node', 'disks', 'os', 'remote_management', 'interfaces']
      additionalProperties: false
  nodes:
    v1.0:
      type: 'array'
      items:
        type: 'object'
        properties:
          name:
            type: 'string'
          node:
            $ref: '#/definitions/node/v1.0'
          disks:
            $ref: '#/definitions/disks/v1.0'
          os:
            type: 'string'
          remote_params:  # Optional YAML anchor, contents will be validated after inject
            type: 'object'
          remote_management:
            $ref: '#/definitions/remote_management/v1.0'
          interfaces:
            $ref: '#/definitions/interfaces/v1.0'
        required: ['name', 'node', 'disks', 'remote_management', 'interfaces']
        additionalProperties: false

##############################################################################
# Top-level structure:
# - define all possible top-level keys, without enforcing a schema for them,
#   just so we can disallow additional properties;
# - require 'version' and allow dynamically generated 'version_x.y' key;
properties:
  # version_x.y keys are auto-added by `validate_schema.py` based on 'version'
  version_1.0:
    type: 'boolean'
  version:
    type: 'number'
    enum: [1.0]
  details:
    type: 'object'
  jumphost:
    type: 'object'
  nodes:
    type: 'array'
required: ['version']
additionalProperties: false

##############################################################################
# Schema versioning
# - based on dynamically added 'version_x.y', require additional PDF blocks
#   and validate them against the proper schema version;
dependencies:
  version_1.0:
    properties:
      details:
        $ref: '#/definitions/details/v1.0'
      jumphost:
        $ref: '#/definitions/jumphost/v1.0'
      nodes:
        $ref: '#/definitions/nodes/v1.0'
    required: ['details', 'jumphost', 'nodes']