Merge "Adding Labels"
[pharos.git] / tools / pharos-validator / src / validation_tool / doc / example / 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 network-config-metadata:             # Meta data for the network configuration
36   title: LF-POD-1 Network config     #
37   version: 0.1                       #
38   created: Mon Dec 28 2015           #
39   comment: None                      #
40
41 # yamllint disable rule:line-length
42 networks:                            # Network configurations
43   admin:                             # Admin configuration (pxe and jumpstart),
44     enabled: true
45     vlan: native                     # VLAN tag to use for Overcloud hosts on this network
46     installer_vm:                    # Network settings for the Installer VM on admin network
47       nic_type: interface            # Indicates if this VM will be bridged to an interface, or to a bond
48       members:
49         - em1                        # Member Interface to bridge to for installer VM (use multiple values for bond)
50       vlan: 29                       # VLAN tag to use for this network on Installer VM, native means none
51       ip: 10.10.25.100               # IP to assign to Installer VM on this network
52     usable_ip_range: 10.10.25.0,10.10.25.100    # Usable ip range, if empty entire range is usable, ex. 192.168.1.10,192.168.1.20
53     gateway: 192.0.2.1               # Gateway (only needed when public_network is disabled)
54     cidr: 10.10.25.0/24              # Subnet in CIDR format 192.168.1.0/24
55     dhcp_range: 10.10.25.50,10.10.25.99          # DHCP range for the admin network, if empty it will be automatically provisioned
56     dns-domain: opnfvlf.org          # Admin network dns domain
57     dns-search: opnfvlf.org          # Admin network dns-search domain
58     dns-upstream:                    # Admin network upstream dns servers
59       - 8.8.8.8                      #
60       - 8.8.4.4                      #
61     ntp-upstream:                    # Admin upstream ntp servers
62       - 0.se.pool.ntp.org            #
63       - 1.se.pool.ntp.org            #
64     nic_mapping:                     # Mapping of network configuration for Overcloud Nodes
65       compute:                       # Mapping for compute profile (nodes that will be used as Compute nodes)
66         phys_type: interface         # Physical interface type (interface or bond)
67         vlan: native                 # VLAN tag to use with this NIC
68         members:                     # Physical NIC members of this mapping (Single value allowed for interface phys_type)
69           - eth1
70       controller:                    # Mapping for controller profile (nodes that will be used as Controller nodes)
71         phys_type: bond
72         vlan: native
73         members:
74           - eth1
75           - eth2
76
77   tenant:                            # Tenant network configuration
78     enabled: true
79     cidr: 11.0.0.0/24                # Subnet in CIDR format 192.168.1.0/24
80     vlan: 10                         # VLAN tag to use for Overcloud hosts on this network
81     mtu: 64000                       # Tenant network MTU
82     overlay_id_range: 2,65535        # Tenant network Overlay segmentation ID range: VNI, VLAN-ID, etc.
83
84     segmentation_type: vxlan         # Tenant network segmentation type:vlan, vxlan, gre
85
86     nic_mapping:                     # Mapping of network configuration for Overcloud Nodes
87       compute:                       # Mapping for compute profile (nodes that will be used as Compute nodes)
88         phys_type: interface         # Physical interface type (interface or bond)
89         vlan: 10                 # VLAN tag to use with this NIC
90         members:                     # Physical NIC members of this mapping (Single value allowed for interface phys_type)
91           - eth1                     # Note, for Apex you may also use the logical nic name (found by nic order), such as "nic1"
92       controller:                    # Mapping for controller profile (nodes that will be used as Controller nodes)
93         phys_type: interface
94         vlan: 10
95         members:
96           - eth1                     # Note, for Apex you may also use the logical nic name (found by nic order), such as "nic1"
97
98   external:                          # Can contain 1 or more external networks
99     - public:                        # "public" network will be the network the installer VM attaches to
100       enabled: true
101       vlan: native
102       mtu: 64000                     # Public network MTU
103       installer_vm:                  # Network settings for the Installer VM on admin network (note only valid on 'public' external network)
104         nic_type: interface          # Indicates if this VM will be bridged to an interface, or to a bond
105         members:
106           - em1                      # Member Interface to bridge to for installer VM (use multiple values for bond)
107         ip: 192.168.37.12            # IP to assign to Installer VM on this network
108       cidr: 192.168.37.0/24
109       gateway: 192.168.37.1
110       floating_ip_range: 192.168.37.200,192.168.37.220  # Range to allocate to floating IPs for the public network with Neutron
111       usable_ip_range: 192.168.37.10,192.168.37.199     # Usable IP range on the public network, usually this is a shared subnet
112       dns_nameservers:               # External dns servers
113         - 8.8.8.8                      #
114         - 8.8.4.4                      #
115       ntp:                           # External upstream NTP servers
116         - 0.se.pool.ntp.org          #
117         - 1.se.pool.ntp.org          #
118       syslog:                        # External Syslog server
119         server: 10.128.1.24          #
120         transport: 'tcp'             #
121       nic_mapping:                     # Mapping of network configuration for Overcloud Nodes
122         compute:                       # Mapping for compute profile (nodes that will be used as Compute nodes)
123           phys_type: interface         # Physical interface type (interface or bond)
124           vlan: 10                 # VLAN tag to use with this NIC
125           members:                     # Physical NIC members of this mapping (Single value allowed for interface phys_type)
126             - eth1
127         controller:                    # Mapping for controller profile (nodes that will be used as Controller nodes)
128           phys_type: interface
129           vlan: 10
130           members:
131             - eth1
132       external_overlay:              # External network to be created in OpenStack by Services tenant
133         name: Public_internet
134         type: flat
135         gateway: 192.168.37.1
136     - private_cloud:                 # another external network
137       enabled: false
138       vlan: 101
139       mtu: 64000
140       cidr: 192.168.38.0/24
141       gateway: 192.168.38.1
142       floating_ip_range: 192.168.38.200,192.168.38.220  # Range to allocate to floating IPs for the public network with Neutron
143       usable_ip_range: 192.168.38.10,192.168.38.199     # Usable IP range on the public network, usually this is a shared subnet
144       dns_nameservers:               # External dns servers
145         - 8.8.8.8                    #
146         - 8.8.4.4                    #
147       ntp:                           # External upstream NTP servers
148         - 0.se.pool.ntp.org          #
149         - 1.se.pool.ntp.org          #
150       syslog:                        # External Syslog server
151         server: 10.128.1.24          #
152         transport: 'tcp'             #
153       nic_mapping:                   # Mapping of network configuration for Overcloud Nodes
154         compute:                     # Mapping for compute profile (nodes that will be used as Compute nodes)
155           phys_type: interface       # Physical interface type (interface or bond)
156           vlan: 101                  # VLAN tag to use with this NIC
157           members:                   # Physical NIC members of this mapping (Single value allowed for interface phys_type)
158             - eth1                   # Note, for Apex you may also use the logical nic name (found by nic order), such as "nic1"
159         controller:                  # Mapping for controller profile (nodes that will be used as Controller nodes)
160           phys_type: interface
161           vlan: 101
162           members:
163             - eth1
164       external_overlay:              # External network to be created in OpenStack by Services tenant
165         name: private_cloud
166         type: vlan
167         segmentation_id: 101
168         gateway: 192.168.38.1
169
170   storage:                           # Storage network configuration
171     enabled: true
172     cidr: 12.0.0.0/24                # Subnet in CIDR format
173     vlan: 12                         # VLAN tag to use for Overcloud hosts on this network
174     mtu: 64000                       # Tenant network MTU
175     nic_mapping:                     # Mapping of network configuration for Overcloud Nodes
176       compute:                       # Mapping for compute profile (nodes that will be used as Compute nodes)
177         phys_type: bond              # Physical interface type (interface or bond)
178         vlan: 12                     # VLAN tag to use with this NIC
179         members:                     # Physical NIC members of this mapping (Single value allowed for interface phys_type)
180           - eth3                     # Note, for Apex you may also use the logical nic name (found by nic order), such as "nic1"
181           - eth4
182       controller:                    # Mapping for controller profile (nodes that will be used as Controller nodes)
183         phys_type: bond
184         vlan: 12
185         members:
186           - eth3
187           - eth4
188
189   api:                               # API network configuration
190     enabled: false
191     cidr: fd00:fd00:fd00:4000::/64   # Subnet in CIDR format
192     vlan: 13                         # VLAN tag to use for Overcloud hosts on this network
193     mtu: 64000                       # Tenant network MTU
194     nic_mapping:                     # Mapping of network configuration for Overcloud Nodes
195       compute:                       # Mapping for compute profile (nodes that will be used as Compute nodes)
196         phys_type: bond              # Physical interface type (interface or bond)
197         vlan: 13                     # VLAN tag to use with this NIC
198         members:                     # Physical NIC members of this mapping (Single value allowed for interface phys_type)
199           - eth3                     # Note, for Apex you may also use the logical nic name (found by nic order), such as "nic1"
200           - eth4
201       controller:                    # Mapping for controller profile (nodes that will be used as Controller nodes)
202         phys_type: bond
203         vlan: 13
204         members:
205           - eth3
206           - eth4
207 # yamllint enable rule:line-length