summaryrefslogtreecommitdiffstats
path: root/config/pdf/pod1.schema.yaml
blob: a602b5627eccc444715c8abfc4be13f1e40825e3 (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
##############################################################################
# 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:
  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})$'
  # Common node schema for jumpserver, cluster nodes
  node:
    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: '^[0-9]+[GT]B?$'
    required: ['type', 'vendor', 'model', 'arch', 'cpus', 'cpu_cflags', 'cores', 'memory']
    additionalProperties: false
  disks:
    type: 'array'
    items:
      type: 'object'
      properties:
        name:
          type: 'string'
          pattern: '^disk[0-9]+$'
        disk_capacity:
          type: 'string'
          pattern: '^[0-9]+[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:
    type: 'object'
    properties:
      type:
        type: 'string'
        enum: ['ipmi', 'amt']
      versions:
        type: 'array'
        items:
          type: 'number'
          enum: [1.0, 2.0]
      user:
        type: 'string'
      pass:
        type: 'string'
      address:
        $ref: '#/definitions/ip_address'
      mac_address:
        $ref: '#/definitions/mac_address'
    required: ['type', 'versions', 'user', 'pass', 'address', 'mac_address']
    additionalProperties: false
  interfaces:
    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

# Do not allow any properties not defined here. This lets us catch typos.
additionalProperties: false

properties:
  details:
    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:
    type: 'object'
    properties:
      name:
        type: 'string'
      node:
        $ref: '#/definitions/node'
      disks:
        $ref: '#/definitions/disks'
      os:
        type: 'string'
      remote_params:  # Optional YAML anchor, contents will be validated below
        type: 'object'
      remote_management:
        $ref: '#/definitions/remote_management'
      interfaces:
        $ref: '#/definitions/interfaces'
    required: ['name', 'node', 'disks', 'os', 'remote_management', 'interfaces']
    additionalProperties: false
  nodes:
    type: 'array'
    items:
      type: 'object'
      properties:
        name:
          type: 'string'
        node:
          $ref: '#/definitions/node'
        disks:
          $ref: '#/definitions/disks'
        os:
          type: 'string'
        remote_params:  # Optional YAML anchor, contents will be validated after inject
          type: 'object'
        remote_management:
          $ref: '#/definitions/remote_management'
        interfaces:
          $ref: '#/definitions/interfaces'
      required: ['name', 'node', 'disks', 'remote_management', 'interfaces']
      additionalProperties: false