config/pdf/idf-pod1.schema.yaml

   1 ##############################################################################
   2 # Copyright (c) 2018 Enea AB and others.
   3 # All rights reserved. This program and the accompanying materials
   4 # are made available under the terms of the Apache License, Version 2.0
   5 # which accompanies this distribution, and is available at
   6 # http://www.apache.org/licenses/LICENSE-2.0
   7 ##############################################################################
   8 ---
   9 $schema: 'http://json-schema.org/schema#'
  10 $id: 'https://github.com/opnfv/pharos/blob/master/config/pdf/pod1.yaml'
  11
  12 definitions:
  13   net_config:
  14     v0.1:
  15       # NOTE: I hope this is going away soon, so I won't model it yet
  16       type: 'object'
  17   daisy:
  18     v0.1:
  19       type: 'object'
  20       # NOTE: To be properly modeled by Daisy maintainers
  21   compass:
  22     v0.1:
  23       type: 'object'
  24       # NOTE: To be properly modeled by Compass4NFV maintainers
  25   fuel:
  26     v0.1:
  27       type: 'object'
  28       properties:
  29         jumphost:
  30           type: 'object'
  31           properties:
  32             bridges:
  33               type: 'object'
  34               properties:
  35                 admin:
  36                   type: ['string', 'null']
  37                 mgmt:
  38                   type: ['string', 'null']
  39                 private:
  40                   type: ['string', 'null']
  41                 public:
  42                   type: ['string', 'null']
  43               required: ['admin', 'mgmt', 'private', 'public']
  44               additionalProperties: false
  45           required: ['bridges']
  46           additionalProperties: false
  47         maas:
  48           type: 'object'
  49           properties:
  50             timeout_comissioning:
  51               type: 'number'
  52             timeout_deploying:
  53               type: 'number'
  54           required: ['timeout_comissioning', 'timeout_deploying']
  55           additionalProperties: false
  56         network:
  57           type: 'object'
  58           properties:
  59             node:
  60               type: 'array'
  61               items:
  62                 type: 'object'
  63                 properties:
  64                   interfaces:
  65                     type: 'array'
  66                     items:
  67                       type: ['string', 'null']
  68                   busaddr:
  69                     type: 'array'
  70                     items:
  71                       type: ['string', 'null']
  72                 required: ['interfaces', 'busaddr']
  73                 additionalProperties: false
  74           required: ['node']
  75           additionalProperties: false
  76       required: ['jumphost', 'network']
  77       additionalProperties: false
  78
  79 ##############################################################################
  80 # Top-level structure:
  81 # - define all possible top-level and second-level keys, without enforcing a
  82 #   schema for second-level, just so we can disallow additional properties;
  83 # - require 'version' and allow dynamically generated 'version_x.y' key;
  84 properties:
  85   idf:
  86     properties:
  87       # version_x.y keys are auto-added by `validate_schema.py` based on 'version'
  88       version_0.1:
  89         type: 'boolean'
  90       version:
  91         type: 'number'
  92         enum: [0.1]
  93       installer:
  94         type: 'array'
  95         items:
  96           type: 'string'
  97           enum: ['apex', 'compass4nfv', 'daisy', 'fuel', 'joid']
  98       net_config:
  99         type: 'object'
 100       fuel:
 101         type: 'object'
 102       daisy:
 103         type: 'object'
 104       compass:
 105         type: 'object'
 106     required: ['version']
 107     additionalProperties: false
 108     ############################################################################
 109     # Schema versioning
 110     # - based on dynamically added 'version_x.y', require additional IDF blocks
 111     #   and validate them against the proper schema version;
 112     dependencies:
 113       version_0.1:
 114         properties:
 115           net_config:
 116             $ref: '#/definitions/net_config/v0.1'
 117           fuel:
 118             $ref: '#/definitions/fuel/v0.1'
 119           daisy:
 120             $ref: '#/definitions/daisy/v0.1'
 121           compass:
 122             $ref: '#/definitions/compass/v0.1'
 123       fuel:
 124         required: ['net_config']
 125       daisy:
 126         required: ['net_config']
 127
 128 # Do not allow any properties not defined here. This lets us catch typos.
 129 additionalProperties: false
 130 required: ['idf']