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   compass:
  18     v0.1:
  19       type: 'object'
  20       # NOTE: To be properly modeled by Compass4NFV maintainers
  21   daisy:
  22     v0.1:
  23       type: 'object'
  24       # NOTE: To be properly modeled by Daisy 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         reclass:  # Optional
  77           type: 'object'
  78           properties:
  79             node:
  80               type: 'array'
  81               items:
  82                 type: 'object'
  83                 properties:
  84                   compute_params:
  85                     type: 'object'
  86                     properties:
  87                       common:  # Optional
  88                         type: 'object'
  89                         properties: &compute_params_common_properties
  90                           nova_cpu_pinning:  # Optional
  91                             type: 'string'
  92                           compute_hugepages_size:
  93                             type: 'string'
  94                             enum: ['2M', '1G']
  95                           compute_hugepages_count:
  96                             type: 'number'
  97                           compute_hugepages_mount:
  98                             type: 'string'
  99                           compute_kernel_isolcpu:  # Optional
 100                             type: 'string'
 101                           compute_ovs_pmd_cpu_mask:  # Optional
 102                             type: ['string', 'number']
 103                           compute_ovs_memory_channels:  # Optional
 104                             type: ['string', 'number']
 105                         required: ['compute_hugepages_size', 'compute_hugepages_count',
 106                                    'compute_hugepages_mount']
 107                         additionalProperties: false
 108                       dpdk:  # Optional
 109                         type: 'object'
 110                         properties:
 111                           <<: *compute_params_common_properties
 112                           compute_dpdk_driver:
 113                             type: 'string'
 114                           compute_ovs_dpdk_socket_mem:
 115                             type: ['string', 'number']
 116                           compute_ovs_dpdk_lcore_mask:
 117                             type: ['string', 'number']
 118                           dpdk0_driver:
 119                             type: 'string'
 120                           dpdk0_n_rxq:
 121                             type: 'number'
 122                         required: ['compute_dpdk_driver', 'dpdk0_driver', 'dpdk0_n_rxq',
 123                                    'compute_ovs_dpdk_socket_mem',
 124                                    'compute_ovs_dpdk_lcore_mask']
 125                         additionalProperties: false
 126                     additionalProperties: false
 127                 required: ['compute_params']
 128                 additionalProperties: false
 129           required: ['node']
 130           additionalProperties: false
 131       required: ['jumphost', 'network']
 132       additionalProperties: false
 133   osa:
 134     v0.1:
 135       type: 'object'
 136       # NOTE: To be properly modeled by XCI maintainers
 137
 138 ##############################################################################
 139 # Top-level structure:
 140 # - define all possible top-level and second-level keys, without enforcing a
 141 #   schema for second-level, just so we can disallow additional properties;
 142 # - require 'version' and allow dynamically generated 'version_x.y' key;
 143 properties:
 144   idf:
 145     properties:
 146       # version_x.y keys are auto-added by `validate_schema.py` based on 'version'
 147       version_0.1:
 148         type: 'boolean'
 149       version:
 150         type: 'number'
 151         enum: [0.1]
 152       installer:
 153         type: 'array'
 154         items:
 155           type: 'string'
 156           enum: ['apex', 'compass4nfv', 'daisy', 'fuel', 'joid', 'osa']
 157       net_config:
 158         type: 'object'
 159       compass:
 160         type: 'object'
 161       daisy:
 162         type: 'object'
 163       fuel:
 164         type: 'object'
 165       osa:
 166         type: 'object'
 167     required: ['version']
 168     additionalProperties: false
 169     ############################################################################
 170     # Schema versioning
 171     # - based on dynamically added 'version_x.y', require additional IDF blocks
 172     #   and validate them against the proper schema version;
 173     dependencies:
 174       version_0.1:
 175         properties:
 176           net_config:
 177             $ref: '#/definitions/net_config/v0.1'
 178           compass:
 179             $ref: '#/definitions/compass/v0.1'
 180           daisy:
 181             $ref: '#/definitions/daisy/v0.1'
 182           fuel:
 183             $ref: '#/definitions/fuel/v0.1'
 184           osa:
 185             $ref: '#/definitions/osa/v0.1'
 186       fuel:
 187         required: ['net_config']
 188       daisy:
 189         required: ['net_config']
 190       osa:
 191         required: ['net_config']
 192
 193 # Do not allow any properties not defined here. This lets us catch typos.
 194 additionalProperties: false
 195 required: ['idf']