tools/pharos-validator/src/validation_tool/doc/network.yaml

   1 ---
   2 # This configuration file defines Network Environment for a
   3 # Baremetal Deployment of OPNFV. It contains default values
   4 # for 5 following networks:
   5 #
   6 # - admin
   7 # - tenant*
   8 # - external*
   9 # - storage*
  10 # - api*
  11 # *) optional networks
  12 #
  13 # Optional networks will be consolidated with the admin network
  14 # if not explicitly configured.
  15 #
  16 # See short description of the networks in the comments below.
  17 #
  18 # "admin" is the short name for Control Plane Network.
  19 # During OPNFV deployment it is used for node provisioning which will require
  20 # PXE booting as well as running a DHCP server on this network.  Be sure to
  21 # disable any other DHCP/TFTP server on this network.
  22 #
  23 # "tenant" is the network used for tenant traffic.
  24 #
  25 # "external" is the network which should have internet or external
  26 # connectivity.  External OpenStack networks will be configured to egress this
  27 # network.  There can be multiple external networks, but only one assigned as
  28 # "public" which OpenStack public API's will register.
  29 #
  30 # "storage" is the network for storage I/O.
  31 #
  32 # "api" is an optional network for splitting out OpenStack service API
  33 # communication.  This should be used for IPv6 deployments.
  34
  35 # yamllint disable rule:line-length
  36 network-config-metadata:             # Meta data for the network configuration
  37   title: LF-POD-1 Network config     #
  38   version: 0.1                       #
  39   created: Mon Dec 28 2015           #
  40   comment: None                      #
  41
  42
  43 networks:                            # Network configurations
  44   admin:                             # Admin configuration (pxe and jumpstart),
  45     enabled: true
  46     vlan: native                     # VLAN tag to use for Overcloud hosts on this network (Admin network is required to be native / untagged for PXE booting)
  47     installer_vm:                    # Network settings for the Installer VM on admin network
  48       nic_type: interface            # Indicates if this VM will be bridged to an interface, or to a bond
  49       members:
  50         - em1                        # Member Interface to bridge to for installer VM (use multiple values for bond)
  51       vlan: native                   # VLAN tag to use for this network on Installer VM, native means none
  52       ip: 192.0.2.1                  # IP to assign to Installer VM on this network
  53     usable_ip_range: 192.0.2.11,192.0.2.99    # Usable ip range, if empty entire range is usable, ex. 192.168.1.10,192.168.1.20
  54     gateway: 192.0.2.1                        # Gateway (only needed when public_network is disabled)
  55     cidr: 192.0.2.0/24                        # Subnet in CIDR format 192.168.1.0/24
  56     dhcp_range: 192.0.2.2,192.0.2.10          # DHCP range for the admin network, if empty it will be automatically provisioned
  57     dns-domain: opnfvlf.org          # Admin network dns domain
  58     dns-search: opnfvlf.org          # Admin network dns-search domain
  59     dns-upstream:                    # Admin network upstream dns servers
  60       - 8.8.8.8                      #
  61       - 8.8.4.4                      #
  62     ntp-upstream:                    # Admin upstream ntp servers
  63       - 0.se.pool.ntp.org            #
  64       - 1.se.pool.ntp.org            #
  65     nic_mapping:                     # Mapping of network configuration for Overcloud Nodes
  66       compute:                       # Mapping for compute profile (nodes that will be used as Compute nodes)
  67         phys_type: interface         # Physical interface type (interface or bond)
  68         vlan: native                 # VLAN tag to use with this NIC
  69         members:                     # Physical NIC members of this mapping (Single value allowed for interface phys_type)
  70           - eth1
  71       controller:                    # Mapping for controller profile (nodes that will be used as Controller nodes)
  72         phys_type: bond
  73         vlan: native
  74         members:
  75           - eth1
  76           - eth2
  77
  78   tenant:                            # Tenant network configuration
  79     enabled: true
  80     cidr: 11.0.0.0/24                # Subnet in CIDR format 192.168.1.0/24
  81     vlan: 10                         # VLAN tag to use for Overcloud hosts on this network
  82     mtu: 64000                       # Tenant network MTU
  83     overlay_id_range: 2,65535        # Tenant network Overlay segmentation ID range: VNI, VLAN-ID, etc.
  84
  85     segmentation_type: vxlan         # Tenant network segmentation type: vlan, vxlan, gre
  86
  87     nic_mapping:                     # Mapping of network configuration for Overcloud Nodes
  88       compute:                       # Mapping for compute profile (nodes that will be used as Compute nodes)
  89         phys_type: interface         # Physical interface type (interface or bond)
  90         vlan: 10                 # VLAN tag to use with this NIC
  91         members:                     # Physical NIC members of this mapping (Single value allowed for interface phys_type)
  92           - eth1                     # Note, for Apex you may also use the logical nic name (found by nic order), such as "nic1"
  93       controller:                    # Mapping for controller profile (nodes that will be used as Controller nodes)
  94         phys_type: interface
  95         vlan: 10
  96         members:
  97           - eth1                     # Note, for Apex you may also use the logical nic name (found by nic order), such as "nic1"
  98
  99   external:                          # Can contain 1 or more external networks
 100     - public:                        # "public" network will be the network the installer VM attaches to
 101       enabled: true
 102       vlan: native
 103       mtu: 64000                     # Public network MTU
 104       installer_vm:                  # Network settings for the Installer VM on admin network (note only valid on 'public' external network)
 105         nic_type: interface          # Indicates if this VM will be bridged to an interface, or to a bond
 106         members:
 107           - em1                      # Member Interface to bridge to for installer VM (use multiple values for bond)
 108         ip: 192.168.37.12            # IP to assign to Installer VM on this network
 109       cidr: 192.168.37.0/24
 110       gateway: 192.168.37.1
 111       floating_ip_range: 192.168.37.200,192.168.37.220  # Range to allocate to floating IPs for the public network with Neutron
 112       usable_ip_range: 192.168.37.10,192.168.37.199     # Usable IP range on the public network, usually this is a shared subnet
 113       dns_nameservers:               # External dns servers
 114         - 8.8.8.8                    #
 115         - 8.8.4.4                    #
 116       ntp:                           # External upstream NTP servers
 117         - 0.se.pool.ntp.org          #
 118         - 1.se.pool.ntp.org          #
 119       syslog:                        # External Syslog server
 120         server: 10.128.1.24          #
 121         transport: 'tcp'             #
 122       nic_mapping:                     # Mapping of network configuration for Overcloud Nodes
 123         compute:                       # Mapping for compute profile (nodes that will be used as Compute nodes)
 124           phys_type: interface         # Physical interface type (interface or bond)
 125           vlan: 10                 # VLAN tag to use with this NIC
 126           members:                     # Physical NIC members of this mapping (Single value allowed for interface phys_type)
 127             - eth1
 128         controller:                    # Mapping for controller profile (nodes that will be used as Controller nodes)
 129           phys_type: interface
 130           vlan: 10
 131           members:
 132             - eth1
 133       external_overlay:              # External network to be created in OpenStack by Services tenant
 134         name: Public_internet
 135         type: flat
 136         gateway: 192.168.37.1
 137     - private_cloud:                 # another external network
 138       enabled: false
 139       vlan: 101
 140       mtu: 64000
 141       cidr: 192.168.38.0/24
 142       gateway: 192.168.38.1
 143       floating_ip_range: 192.168.38.200,192.168.38.220  # Range to allocate to floating IPs for the public network with Neutron
 144       usable_ip_range: 192.168.38.10,192.168.38.199     # Usable IP range on the public network, usually this is a shared subnet
 145       dns_nameservers:               # External dns servers
 146         - 8.8.8.8                    #
 147         - 8.8.4.4                    #
 148       ntp:                           # External upstream NTP servers
 149         - 0.se.pool.ntp.org          #
 150         - 1.se.pool.ntp.org          #
 151       syslog:                        # External Syslog server
 152         server: 10.128.1.24          #
 153         transport: 'tcp'             #
 154       nic_mapping:                   # Mapping of network configuration for Overcloud Nodes
 155         compute:                     # Mapping for compute profile (nodes that will be used as Compute nodes)
 156           phys_type: interface       # Physical interface type (interface or bond)
 157           vlan: 101                  # VLAN tag to use with this NIC
 158           members:                   # Physical NIC members of this mapping (Single value allowed for interface phys_type)
 159             - eth1                   # Note, for Apex you may also use the logical nic name (found by nic order), such as "nic1"
 160         controller:                  # Mapping for controller profile (nodes that will be used as Controller nodes)
 161           phys_type: interface
 162           vlan: 101
 163           members:
 164             - eth1
 165       external_overlay:              # External network to be created in OpenStack by Services tenant
 166         name: private_cloud
 167         type: vlan
 168         segmentation_id: 101
 169         gateway: 192.168.38.1
 170
 171   storage:                           # Storage network configuration
 172     enabled: true
 173     cidr: 12.0.0.0/24                # Subnet in CIDR format
 174     vlan: 12                         # VLAN tag to use for Overcloud hosts on this network
 175     mtu: 64000                       # Tenant network MTU
 176     nic_mapping:                     # Mapping of network configuration for Overcloud Nodes
 177       compute:                       # Mapping for compute profile (nodes that will be used as Compute nodes)
 178         phys_type: bond              # Physical interface type (interface or bond)
 179         vlan: 12                     # VLAN tag to use with this NIC
 180         members:                     # Physical NIC members of this mapping (Single value allowed for interface phys_type)
 181           - eth3                     # Note, for Apex you may also use the logical nic name (found by nic order), such as "nic1"
 182           - eth4
 183       controller:                    # Mapping for controller profile (nodes that will be used as Controller nodes)
 184         phys_type: bond
 185         vlan: 12
 186         members:
 187           - eth3
 188           - eth4
 189
 190   api:                               # API network configuration
 191     enabled: false
 192     cidr: fd00:fd00:fd00:4000::/64   # Subnet in CIDR format
 193     vlan: 13                         # VLAN tag to use for Overcloud hosts on this network
 194     mtu: 64000                       # Tenant network MTU
 195     nic_mapping:                     # Mapping of network configuration for Overcloud Nodes
 196       compute:                       # Mapping for compute profile (nodes that will be used as Compute nodes)
 197         phys_type: bond              # Physical interface type (interface or bond)
 198         vlan: 13                     # VLAN tag to use with this NIC
 199         members:                     # Physical NIC members of this mapping (Single value allowed for interface phys_type)
 200           - eth3                     # Note, for Apex you may also use the logical nic name (found by nic order), such as "nic1"
 201           - eth4
 202       controller:                    # Mapping for controller profile (nodes that will be used as Controller nodes)
 203         phys_type: bond
 204         vlan: 13
 205         members:
 206           - eth3
 207           - eth4
 208
 209 # JOID specific settings
 210 joid:
 211
 212 # Compass specific settings
 213 compass:
 214
 215 # Apex specific settings
 216 apex:
 217   networks:
 218     admin:
 219       introspection_range: 192.0.2.100,192.0.2.120      # Range used for introspection phase (examining nodes)
 220 # Fuel specific settings
 221 fuel: