Add http(s)_proxy handling to apex
[apex.git] / config / network / network_settings.yaml
index f768064..ffe3a18 100644 (file)
+---
 # This configuration file defines Network Environment for a
 # Baremetal Deployment of OPNFV. It contains default values
-# for 4 following networks:
+# for 5 following networks:
 #
 # - admin
-# - private*
-# - public
+# - tenant*
+# - external*
 # - storage*
-#
+# - api*
 # *) optional networks
 #
-# Any values missing from this configuration file will be
-# auto-detected by deployment script from the existing network
-# configuration of the jumphost.
-#
 # Optional networks will be consolidated with the admin network
-# if not explicitely configured.
+# if not explicitly configured.
 #
 # See short description of the networks in the comments below.
 #
+# "admin" is the short name for Control Plane Network.
+# This network should be IPv4 even it is an IPv6 deployment
+# IPv6 does not have PXE boot support.
+# During OPNFV deployment it is used for node provisioning which will require
+# PXE booting as well as running a DHCP server on this network.  Be sure to
+# disable any other DHCP/TFTP server on this network.
+#
+# "tenant" is the network used for tenant traffic.
+#
+# "external" is the network which should have internet or external
+# connectivity.  External OpenStack networks will be configured to egress this
+# network.  There can be multiple external networks, but only one assigned as
+# "public" which OpenStack public API's will register.
+#
+# "storage" is the network for storage I/O.
+#
+# "api" is an optional network for splitting out OpenStack service API
+# communication.  This should be used for IPv6 deployments.
 
-# DNS Servers for all nodes, comma delimited list
-dns_servers: ["8.8.8.8", "8.8.4.4"]
 
-# Domain name to use for undercloud/overcloud nodes
-domain_name: 'opnfvapex.com'
+# Meta data for the network configuration
+network-config-metadata:
+  title: LF-POD-1 Network config
+  version: 0.1
+  created: Mon Dec 28 2015
+  comment: None
 
-# "admin" is the short name for Control Plane Network.
-# During OPNFV deployment it is used for node provisioning so
-# PXE boot should be enabled for the related interfaces on all
-# the nodes in the OPNFV cluster. After the deployment this
-# network is used as the OpenStack management network which
-# carries e.g. communication between its internal components.
-#
-admin_network:
-  enabled: true
-  network_type: bridged
-  bridged_interface: ''
-  bond_interfaces: ''
-  compute_interface: nic1
-  controller_interface: nic1
-  usable_ip_range: 192.0.2.11,192.0.2.99
-  gateway: 192.0.2.1
-  provisioner_ip: 192.0.2.1
-  cidr: 192.0.2.0/24
-  dhcp_range: 192.0.2.2,192.0.2.10
-  introspection_range: 192.0.2.100,192.0.2.120
+# DNS Settings
+dns-domain: opnfvlf.org
+dns-search: opnfvlf.org
+dns_nameservers:
+  - 8.8.8.8
+  - 8.8.4.4
+# NTP servers
+ntp:
+  - 0.se.pool.ntp.org
+  - 1.se.pool.ntp.org
+# Syslog server
+syslog:
+  server: 10.128.1.24
+  transport: 'tcp'
 
-# "private" is an optional network used as underlying physical
-# network for virtual provider and tenant networks created by
-# users. Traffic between virtual machines is carried by this
-# network.
-#
-private_network:
-  enabled: true
-  vlan: native
-  cidr: 11.0.0.0/24
-  compute_interface: nic2
-  controller_interface: nic2
+# http(s) proxy settings added to /etc/environment of uc and oc nodes
+# http_proxy: http://proxy.server:8080
+# https_proxy: https://proxy.server:8081
 
-# "public" network is used for external connectivity.
-# The external network provides Internet access for virtual
-# machines. If floating IP range is defined for this network,
-# floating IP addresses can be used for accessing virtual
-# machines from outside of OPNFV cluster. Also external REST
-# API calls use this network.
-#
-public_network:
-  enabled: true
-  network_type: ''
-  bridged_interface: ''
-  compute_interface: nic3
-  controller_interface: nic3
-  vlan: native
-  cidr: 192.168.37.0/24
-  gateway: 192.168.37.1
-  floating_ip_range: 192.168.37.200,192.168.37.220
-  usable_ip_range: 192.168.37.10,192.168.37.199
-  provisioner_ip: 192.168.37.1
+# Common network settings
+networks:
+  # Admin configuration (pxe and jumpstart)
+  admin:
+    enabled: true
+    # Network settings for the Installer VM on admin network
+    installer_vm:
+      # Indicates if this VM will be bridged to an interface, or to a bond
+      nic_type: interface
+      # Interfaces to bridge for installer VM (use multiple values for bond)
+      members:
+        - em1
+      # VLAN tag to use for this network on Installer VM, native means none
+      vlan: native
+      # IP to assign to Installer VM on this network
+      ip: 192.0.2.1
+    # Usable ip range for the overcloud node IPs (including VIPs)
+    # Last IP is used for host bridge (i.e. br-admin).
+    # If empty entire range is usable.
+    # Cannot overlap with dhcp_range or introspection_range.
+    overcloud_ip_range:
+      - 192.0.2.51
+      - 192.0.2.99
+    # Gateway (only needed when public_network is disabled)
+    gateway: 192.0.2.1
+    # Subnet in CIDR format 192.168.1.0/24
+    cidr: 192.0.2.0/24
+    # DHCP range for the admin network, automatically provisioned if empty
+    dhcp_range:
+      - 192.0.2.2
+      - 192.0.2.50
+    # Mapping of network configuration for Overcloud Nodes
+    nic_mapping:
+      # Mapping for compute profile (nodes assigned as Compute nodes)
+      compute:
+        # Physical interface type (interface or bond)
+        phys_type: interface
+        # Physical NIC members (Single value allowed for phys_type: interface)
+        members:
+          - eth0
+      # Mapping for controller profile (nodes assigned as Controller nodes)
+      controller:
+        phys_type: interface
+        members:
+          - eth0
 
-# "storage" is an optional network used by storage backends.
-# You can configure this network in order to reduce load on
-# Control Plane Network.
-#
-storage_network:
-  enabled: true
-  vlan: native
-  cidr: 12.0.0.0/24
-  compute_interface: nic4
-  controller_interface: nic4
+  # Tenant network configuration
+  tenant:
+    enabled: true
+    # Subnet in CIDR format 192.168.1.0/24
+    cidr: 11.0.0.0/24
+    # Tenant network MTU
+    mtu: 1500
+    # Tenant network Overlay segmentation ID range:
+    # VNI, VLAN-ID, etc.
+    overlay_id_range: 2,65535
+
+    # Tenant network segmentation type:
+    # vlan, vxlan, gre
+    segmentation_type: vxlan
+    # Mapping of network configuration for Overcloud Nodes
+    nic_mapping:
+      # Mapping for compute profile (nodes assigned as Compute nodes)
+      compute:
+        # Physical interface type (interface/bond)
+        phys_type: interface
+        # UIO driver to use for DPDK scenarios.
+        # The value is ignored for non-DPDK scenarios.
+        uio_driver: uio_pci_generic
+        # VLAN tag to use with this NIC
+        vlan: native
+        # Physical NIC members of this mapping
+        # Single value allowed for phys_type: interface
+        members:
+          # Note logical name like nic1 not valid for fdio deployment yet.
+          - eth1
+      # Mapping for controller profile (nodes assigned as Controller nodes)
+      controller:
+        # Physical interface type (interface/bond)
+        phys_type: interface
+        vlan: native
+        # Note: logicial names like nic1 are not valid for fdio deployment yet.
+        members:
+          - eth1
+
+  # Can contain 1 or more external networks
+  external:
+    - public:
+      enabled: true
+      # Public network MTU
+      mtu: 1500
+      # Network settings for the Installer VM on external network
+      # (note only valid on 'public' external network)
+      installer_vm:
+        # Indicates if this VM will be bridged to an interface, or to a bond
+        nic_type: interface
+        vlan: native
+        # Interfaces to bridge for installer VM (use multiple values for bond)
+        members:
+          - em1
+        # IP to assign to Installer VM on this network
+        ip: 192.168.37.1
+      cidr: 192.168.37.0/24
+      gateway: 192.168.37.1
+      # Range to allocate to floating IPs for the public network with Neutron
+      floating_ip_range:
+        - 192.168.37.200
+        - 192.168.37.220
+      # Usable ip range for the overcloud node IPs (including VIPs)
+      # Last IP will be used for host bridge (i.e. br-public).
+      # If empty entire range is usable.
+      # Cannot overlap with dhcp_range or introspection_range.
+      overcloud_ip_range:
+        - 192.168.37.10
+        - 192.168.37.199
+      # Mapping of network configuration for Overcloud Nodes
+      nic_mapping:
+        # Mapping for compute profile (nodes assigned as Compute nodes)
+        compute:
+          # Physical interface type (interface or bond)
+          phys_type: interface
+          # VLAN tag to use with this NIC
+          vlan: native
+          # Physical NIC members of this mapping
+          # Single value allowed for phys_type: interface
+          members:
+            - eth2
+        # Mapping for controller profile (nodes assigned as Controller nodes)
+        controller:
+          phys_type: interface
+          vlan: native
+          members:
+            - eth2
+      # External network to be created in OpenStack by Services tenant
+      external_overlay:
+        name: Public_internet
+        type: flat
+        gateway: 192.168.37.1
+    # another external network
+    # This is an example and not yet supported
+    - private_cloud:
+      enabled: false
+      mtu: 1500
+      # Network settings for the Installer VM on external network
+      # note only valid on 'public' external network
+      installer_vm:
+        # Indicates if this VM will be bridged to an interface, or to a bond
+        nic_type: interface
+        vlan: 101
+        # Interfaces to bridge for installer VM (use multiple values for bond)
+        members:
+          - em1
+        # IP to assign to Installer VM on this network
+        ip: 192.168.38.1
+      cidr: 192.168.38.0/24
+      gateway: 192.168.38.1
+      # Range to allocate to floating IPs for the public network with Neutron
+      floating_ip_range:
+        - 192.168.38.200
+        - 192.168.38.220
+      # Usable IP range for overcloud nodes (including VIPs)i
+      # usually this is a shared subnet.
+      # Cannot overlap with dhcp_range or introspection_range.
+      overcloud_ip_range:
+        - 192.168.38.10
+        - 192.168.38.199
+      # Mapping of network configuration for Overcloud Nodes
+      nic_mapping:
+        # Mapping for compute profile (nodes assigned as Compute nodes)
+        compute:
+          # Physical interface type (interface or bond)
+          phys_type: interface
+          # VLAN tag to use with this NIC
+          vlan: 101
+          # Physical NIC members of this mappingi
+          # Single value allowed for phys_type: interface
+          # Note: logical names like nic1 are not valid for fdio deployment yet.
+          members:
+            - eth3
+        # Mapping for controller profile (nodes assigned as Controller nodes)
+        controller:
+          phys_type: interface
+          vlan: 101
+          members:
+            - eth3
+      # External network to be created in OpenStack by Services tenant
+      external_overlay:
+        name: private_cloud
+        type: vlan
+        segmentation_id: 101
+        gateway: 192.168.38.1
+
+  # Storage network configuration
+  storage:
+    enabled: true
+    # Subnet in CIDR format
+    cidr: 12.0.0.0/24
+    # Storage network MTU
+    mtu: 1500
+    # Mapping of network configuration for Overcloud Nodes
+    nic_mapping:
+      # Mapping for compute profile (nodes assigned as Compute nodes)
+      compute:
+        # Physical interface type (interface or bond)
+        phys_type: interface
+        # VLAN tag to use with this NIC
+        vlan: native
+        # Physical NIC members of this mapping
+        # Single value allowed for phys_type: interface
+        members:
+          # Note logical names like nic1 not valid for fdio deployment yet.
+          - eth3
+      # Mapping for controller profile (nodes assigned as Controller nodes)
+      controller:
+        phys_type: interface
+        vlan: native
+        members:
+          - eth3
+
+  api:
+    # API network configuration
+    enabled: false
+    # Subnet in CIDR format
+    cidr: fd00:fd00:fd00:4000::/64
+    # VLAN tag to use for Overcloud hosts on this network
+    vlan: 13
+    # Api network MTU
+    mtu: 1500
+    # Mapping of network configuration for Overcloud Nodes
+    nic_mapping:
+      # Mapping for compute profile (nodes assigned as Compute nodes)
+      compute:
+        # Physical interface type (interface or bond)
+        phys_type: interface
+        # VLAN tag to use with this NIC
+        vlan: native
+        # Physical NIC members of this mapping
+        # Single value allowed for phys_type: interface
+        # Note logical names like nic1 not valid for fdio deployment yet.
+        members:
+          - eth4
+      # Mapping for controller profile (nodes assigned as Controller nodes)
+      controller:
+        phys_type: interface
+        vlan: native
+        members:
+          - eth4
 
-#admin_network:
-#  enabled: true
-#  network_type: bridged                             #Indicates if this network will be bridged to an interface, or to a bond
-#  bridged_interface: ''                             #Interface to bridge to for installer VM
-#  bond_interfaces: ''                               #Interfaces to create bond with for installer VM
-#  compute_interface: nic4                           #Interface used for this network on the compute node.  Can either be logical nic name like "nic1" or real name like "eth1"
-#  controller_interface: nic4                        #Interface used for this network on the controller node.  Can either be logical nic name like "nic1" or real name like "eth1"
-#  vlan: native                                      #VLAN tag to use, native means none
-#  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
-#  gateway: 192.0.2.1                                #Gateway (only needed when public_network is disabled), if empty it is auto-detected
-#  provisioner_ip: 192.0.2.1                         #installer VM IP, if empty it is the next available IP in the admin subnet
-#  cidr: 192.0.2.0/24                                #subnet in CIDR format 192.168.1.0/24, if empty it will be auto-detected
-#  dhcp_range: 192.0.2.2,192.0.2.10                  #dhcp range for the admin network, if empty it will be automatically provisioned
-#  introspection_range: 192.0.2.100,192.0.2.120      #Range used for introspection phase (examining nodes)
-#private_network:
-#  enabled: false                                    #If disabled, internal api traffic will collapse to admin_network
-#public_network:
-#  enabled: true                                     #If disabled, public_network traffic will collapse to admin network
-#  network_type: ''
-#  bridged_interface: ''
-#  cidr: 192.168.37.0/24
-#  gateway: 192.168.37.1
-#  floating_ip_range: 192.168.37.200,192.168.37.220  #Range to allocate to floating IPs for the public network with Neutron
-#  usable_ip_range: 192.168.37.10,192.168.37.199     #Usable IP range on the public network, usually this is a shared subnet
-#  provisioner_ip: 192.168.37.1
-#storage_network:
-#  enabled: false                                    #If disabled, storage_network traffic will collapse to admin network
+# Apex specific settings
+apex:
+  networks:
+    admin:
+      # Range used for introspection phase (examining nodes).
+      # This cannot overlap with dhcp_range or overcloud_ip_range.
+      # for the overcloud default external network
+      introspection_range:
+        - 192.0.2.100
+        - 192.0.2.120