diff --git a/contents/contents-pre-install-guide.rst b/contents/contents-pre-install-guide.rst index 43ab8cc1f..832c0b7b8 100644 --- a/contents/contents-pre-install-guide.rst +++ b/contents/contents-pre-install-guide.rst @@ -1,10 +1,14 @@ .. include:: /pages/pre-install-guide/0010-intro.rst .. include:: /pages/pre-install-guide/0020-system-requirements.rst .. include:: /pages/pre-install-guide/0025-supported-software-list.rst +.. include:: /pages/pre-install-guide/4000-planning-summary.rst +.. include:: /pages/pre-install-guide/4100-mode-ha.rst +.. include:: /pages/pre-install-guide/4200-net-topology.rst +.. include:: /pages/pre-install-guide/4300-linux-distro.rst +.. include:: /pages/pre-install-guide/4400-nodes-roles.rst +.. include:: /pages/pre-install-guide/4500-hardware.rst .. include:: /pages/pre-install-guide/7000-sahara-plan.rst -.. include:: /pages/pre-install-guide/0031-fuel-configuration.rst .. include:: /pages/pre-install-guide/0060-quick-install-fuel.rst -.. include:: /pages/pre-install-guide/0051-network-plan.rst .. include:: /pages/pre-install-guide/0080-reference-configuration.rst .. include:: /pages/pre-install-guide/0090-appendix.rst .. include:: /pages/pre-install-guide/0030-pre-installation-checklist.rst diff --git a/contents/contents-refarch.rst b/contents/contents-refarch.rst index 093b6c326..6b864954c 100644 --- a/contents/contents-refarch.rst +++ b/contents/contents-refarch.rst @@ -6,9 +6,11 @@ .. include:: /pages/reference-architecture/1100-ha-notes.rst .. include:: /pages/reference-architecture/1200-mysql-galera.rst .. include:: /pages/reference-architecture/1700-ceph.rst -.. include:: /pages/reference-architecture/0030-cluster-sizing.rst .. include:: /pages/reference-architecture/0045-storage.rst .. include:: /pages/reference-architecture/6000-network-architecture.rst +.. include:: /pages/reference-architecture/6030-router.rst +.. include:: /pages/reference-architecture/6034-switch.rst .. include:: /pages/reference-architecture/6050-neutron-topologies.rst +.. include:: /pages/reference-architecture/6070-nova-topologies.rst .. include:: /pages/reference-architecture/0100-openvswitch.rst .. include:: /pages/reference-architecture/0110-bonding.rst diff --git a/index.rst b/index.rst index ef1e9ffc1..f3cd63956 100644 --- a/index.rst +++ b/index.rst @@ -15,7 +15,7 @@ PDFs ---- The following Mirantis OpenStack documentation is available in PDF: -* `Pre-Installation Guide `_ +* `Pre-Installation Guide `_ Prerequisites and pre-installation steps that you must execute before installing Fuel and deploying Mirantis OpenStack. diff --git a/pages/install-guide/0000-intro/0200-deploy-modes.rst b/pages/install-guide/0000-intro/0200-deploy-modes.rst index e55c958ee..7ab6e83a7 100644 --- a/pages/install-guide/0000-intro/0200-deploy-modes.rst +++ b/pages/install-guide/0000-intro/0200-deploy-modes.rst @@ -1,18 +1,18 @@ Deployment Modes ------------------------------ +---------------- You can use Fuel for OpenStack to create virtually any OpenStack configuration. However, Mirantis provides several pre-defined architectures for your convenience. The pre-defined architectures include: - + * **Multi-node** The Multi-node environment provides an easy way to install an entire OpenStack environment without requiring the degree of increased hardware involved in ensuring high availability. Mirantis recommends that you use this architecture for testing purposes. - + * **Multi-node HA** The Multi-node with HA environment is dedicated for highly available production deployments. Using Multi-node with HA you can deploy @@ -22,6 +22,3 @@ The pre-defined architectures include: With Fuel, you can create your own cloud environment that includes additional components. -For more information, contact `Mirantis `_. - -.. seealso:: :ref:`Reference Architecture` diff --git a/pages/install-guide/0070-networks.rst b/pages/install-guide/0070-networks.rst index 09ac3df2e..faf39b1f6 100644 --- a/pages/install-guide/0070-networks.rst +++ b/pages/install-guide/0070-networks.rst @@ -5,5 +5,3 @@ .. include:: /pages/install-guide/0070-networks/0200-fuel-deployment-schema.rst .. include:: /pages/install-guide/0070-networks/0210-config-network.rst .. include:: /pages/install-guide/0070-networks/0220-map-logical-to-physical-nic.rst -.. include:: /pages/install-guide/0070-networks/0300-switch-config.rst -.. include:: /pages/install-guide/0070-networks/0350-router.rst diff --git a/pages/install-guide/0070-networks/0300-switch-config.rst b/pages/install-guide/0070-networks/0300-switch-config.rst deleted file mode 100644 index 7f4d22148..000000000 --- a/pages/install-guide/0070-networks/0300-switch-config.rst +++ /dev/null @@ -1,74 +0,0 @@ -Switch -++++++ - -Fuel can configure hosts, however switch configuration is still manual work. -Unfortunately the set of configuration steps, and even the terminology used, -is different for different vendors, so we will try to provide -vendor-agnostic information on how traffic should flow and leave the -vendor-specific details to you. We will provide an example for a Cisco switch. - -First of all, you should configure access ports to allow non-tagged PXE booting -connections from all Slave nodes to the Fuel node. We refer this network -as the Fuel network. -By default, the Fuel Master node uses the `eth0` interface to serve PXE -requests on this network, but this can be changed :ref:`during installation -` of the Fuel Master node. -So if that's left unchanged, you have to set the switch port for `eth0` of Fuel -Master node to access mode. -We recommend that you use the `eth0` interfaces of all other nodes for PXE booting -as well. Corresponding ports must also be in access mode. - -Taking into account that this is the network for PXE booting, do not mix -this L2 segment with any other network segments. Fuel runs a DHCP -server, and if there is another DHCP on the same L2 network segment, both the -company's infrastructure and Fuel's will be unable to function properly. -You also need to configure each of the switch's ports connected to nodes as an -"STP Edge port" (or a "spanning-tree port fast trunk", according to Cisco -terminology). If you don't do that, DHCP timeout issues may occur. - -As long as the Fuel network is configured, Fuel can operate. -Other networks are required for OpenStack environments, and currently all of -these networks live in VLANs over the one or multiple physical interfaces on a -node. This means that the switch should pass tagged traffic, and untagging is done -on the Linux hosts. - -.. note:: For the sake of simplicity, all the VLANs specified on the networks tab of - the Fuel UI should be configured on switch ports, pointing to Slave nodes, - as tagged. - -Of course, it is possible to specify as tagged only certain ports for certain -nodes. However, in the current version, all existing networks are automatically -allocated for each node, with any role. -And network check will also check if tagged traffic pass, even if some nodes do -not require this check (for example, Cinder nodes do not need fixed network traffic). - -This is enough to deploy the OpenStack environment. However, from a -practical standpoint, it's still not really usable because there is no -connection to other corporate networks yet. To make that possible, you must -configure uplink port(s). - -One of the VLANs may carry the office network. To provide access to the Fuel Master -node from your network, any other free physical network interface on the -Fuel Master node can be used and configured according to your network -rules (static IP or DHCP). The same network segment can be used for -Public and Floating ranges. In this case, you must provide the corresponding -VLAN ID and IP ranges in the UI. One Public IP per node will be used to SNAT -traffic out of the VMs network, and one or more floating addresses per VM -instance will be used to get access to the VM from your network, or -even the global Internet. To have a VM visible from the Internet is similar to -having it visible from corporate network - corresponding IP ranges and VLAN IDs -must be specified for the Floating and Public networks. One current limitation -of Fuel is that the user must use the same L2 segment for both Public and -Floating networks. - -Example configuration for one of the ports on a Cisco switch:: - - interface GigabitEthernet0/6 # switch port - description s0_eth0 jv # description - switchport trunk encapsulation dot1q # enables VLANs - switchport trunk native vlan 262 # access port, untags VLAN 262 - switchport trunk allowed vlan 100,102,104 # 100,102,104 VLANs are passed with tags - switchport mode trunk # To allow more than 1 VLAN on the port - spanning-tree portfast trunk # STP Edge port to skip network loop - # checks (to prevent DHCP timeout issues) - vlan 262,100,102,104 # Might be needed for enabling VLANs diff --git a/pages/install-guide/0070-networks/0350-router.rst b/pages/install-guide/0070-networks/0350-router.rst deleted file mode 100644 index c8b5af49e..000000000 --- a/pages/install-guide/0070-networks/0350-router.rst +++ /dev/null @@ -1,16 +0,0 @@ -Router -++++++ - -To make it possible for VMs to access the outside world, you must have an IP -address set on a router in the Public network. In the examples provided, -that IP is 12.0.0.1 in VLAN 101. - -Fuel UI has a special field on the networking tab for the gateway address. As -soon as deployment of OpenStack is started, the network on nodes is -reconfigured to use this gateway IP as the default gateway. - -If Floating addresses are from another L3 network, then you have to configure the -IP address (or even multiple IPs if Floating addresses are from more than one L3 -network) for them on the router as well. - -Otherwise, Floating IPs on nodes will be inaccessible. diff --git a/pages/pre-install-guide/0031-fuel-configuration.rst b/pages/pre-install-guide/0031-fuel-configuration.rst deleted file mode 100644 index a85bfbaea..000000000 --- a/pages/pre-install-guide/0031-fuel-configuration.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. contents:: :local: - :depth: 3 - -.. include:: /pages/pre-install-guide/0031-fuel-configuration/0032-prepare-most-deploy.rst diff --git a/pages/pre-install-guide/0031-fuel-configuration/0032-prepare-most-deploy.rst b/pages/pre-install-guide/0031-fuel-configuration/0032-prepare-most-deploy.rst deleted file mode 100644 index bc4bec3e4..000000000 --- a/pages/pre-install-guide/0031-fuel-configuration/0032-prepare-most-deploy.rst +++ /dev/null @@ -1,77 +0,0 @@ -.. _calculator: https://www.mirantis.com/openstack-services/bom-calculator/ - -.. index:: Preparing for the Mirantis OpenStack Deployment - -.. _PrepMirDep: - -Preparing the Mirantis OpenStack Deployment -=========================================== - -Before installation, plan your deployment. Determine the deployment type that -is appropriate for you configuration needs. You may want to print this -list and make notes indicating your selection so you can be sure -you have planned your deployment correctly. - -The following table provides a list of configuration steps that you must -complete to plan the Mirantis OpenStack deployment. - -+----+----------------------------+-------------------------------------------+ -| | Step Description | Additional Information | -+====+============================+===========================================+ -| 1 | Consider which deployment | For more information, see: | -| | mode you will deploy | :ref:`Reference Architecture `. | -| | (Multi-node HA or non HA) | | -+----+----------------------------+-------------------------------------------+ -| 2 | Select a network service | For more information, see: | -| | (Nova-Network: FlatDHCP, | :ref:`Network `. | -| | VLAN manager or Neutron: | | -| | GRE, VLAN). | | -+----+----------------------------+-------------------------------------------+ -| 3 | Prepare all the necessary | For more information, see: the Mirantis | -| | hardware. | Hardware Bill of Materials calculator_, | -| | | HardwarePrerequisites_ | -+----+----------------------------+-------------------------------------------+ -| 4 | Plan a role (or roles) to | A node may act as a controller, compute | -| | be assigned to each node | or storage node - or combine storage or | -| | server. | compute role. Network services are | -| | | automatically installed onto the | -| | | controller when utilizing the Fuel UI. | -+----+----------------------------+-------------------------------------------+ -| 5 | Prepare an addressing plan | Identify the network addresses and VLAN | -| | and network association. | IDs for your Public, floating, Management,| -| | | Storage, and virtual machine (fixed) | -| | | networks. For more information on how to | -| | | plan your network, see: | -| | | NetworkConfiguration_ | -+----+----------------------------+-------------------------------------------+ -| 6 | Prepare a logical network | For more information, see: | -| | diagram. | NetworkConfiguration_ | -+----+----------------------------+-------------------------------------------+ -| 7 | Connect the Fuel and node | For more information, see the instructions| -| | servers' NICs to the | for your network. | -| | switches. | | -+----+----------------------------+-------------------------------------------+ -| 8 | Connect the Fuel and node | For more information, see the instructions| -| | servers' IPMI cards to the | for your hardware. | -| | out of band management | | -| | network. | | -+----+----------------------------+-------------------------------------------+ -| 9 | Configure access to the | For more information, see the IPMI | -| | node servers through IPMI | instructions for your hardware. | -+----+----------------------------+-------------------------------------------+ -| 10 | Prepare the proper | According to your addressing plan and | -| | physical network | logical network diagram. | -| | configuration (configure | | -| | switches, routers, etc). | | -+----+----------------------------+-------------------------------------------+ -| 11 | Connect the OpenStack | For more information, see the instructions| -| | networks to the server | for your routers and/or switches. | -| | Ethernet port on each | | -| | server. | | -+----+----------------------------+-------------------------------------------+ -| 12 | Install the Fuel server | For more information, see: | -| | | FuelQuickInstall_. | -+----+----------------------------+-------------------------------------------+ - -.. seealso:: `Mirantis Services `_ - diff --git a/pages/pre-install-guide/0051-network-plan.rst b/pages/pre-install-guide/0051-network-plan.rst deleted file mode 100644 index e51e24f5a..000000000 --- a/pages/pre-install-guide/0051-network-plan.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. contents:: :local: - :depth: 3 - -.. include:: /pages/pre-install-guide/0051-network-plan/0100-net-config-options.rst -.. include:: /pages/pre-install-guide/0051-network-plan/0110-openstack-networks.rst -.. include:: /pages/pre-install-guide/0051-network-plan/0200-topology-include.rst diff --git a/pages/pre-install-guide/0051-network-plan/0100-net-config-options.rst b/pages/pre-install-guide/0051-network-plan/0100-net-config-options.rst deleted file mode 100644 index f8c5caecf..000000000 --- a/pages/pre-install-guide/0051-network-plan/0100-net-config-options.rst +++ /dev/null @@ -1,11 +0,0 @@ - -.. index:: Network Configuration Options - -.. _NetworkConfiguration: - -Network Configuration Options -============================= - -This section describes how to configure network settings depending on -your environment requirements and prerequisites. - diff --git a/pages/pre-install-guide/0051-network-plan/0110-openstack-networks.rst b/pages/pre-install-guide/0051-network-plan/0110-openstack-networks.rst deleted file mode 100644 index fe9b2450a..000000000 --- a/pages/pre-install-guide/0051-network-plan/0110-openstack-networks.rst +++ /dev/null @@ -1,11 +0,0 @@ -Networks used by OpenStack --------------------------- - -The OpenStack architecture defines a set of -logical networks that are used in the OpenStack environment; -see :ref:`logical-networks-arch`. - -Your network plan must define how these logical networks -will be mapped to the physical NICs in your data center. -You will define this mapping in Fuel -before your environment is deployed. diff --git a/pages/pre-install-guide/0051-network-plan/0200-topology-include.rst b/pages/pre-install-guide/0051-network-plan/0200-topology-include.rst deleted file mode 100644 index a8e29f2fe..000000000 --- a/pages/pre-install-guide/0051-network-plan/0200-topology-include.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. include:: /pages/pre-install-guide/0051-network-plan/topology/0210-topology.intro.rst -.. include:: /pages/pre-install-guide/0051-network-plan/topology/0600-nova-topologies.rst -.. include:: /pages/pre-install-guide/0051-network-plan/topology/0700-neutron-topologies.rst -.. include:: /pages/pre-install-guide/0051-network-plan/topology/0900-routing-req.rst - diff --git a/pages/pre-install-guide/0051-network-plan/topology/0210-topology.intro.rst b/pages/pre-install-guide/0051-network-plan/topology/0210-topology.intro.rst deleted file mode 100644 index 67024ebf0..000000000 --- a/pages/pre-install-guide/0051-network-plan/topology/0210-topology.intro.rst +++ /dev/null @@ -1,7 +0,0 @@ -Network Deployment Models -========================= - -This section describes the following network deployment models: - -* :ref:`Nova-network ` -* :ref:`Neutron ` diff --git a/pages/pre-install-guide/0051-network-plan/topology/0600-nova-topologies.rst b/pages/pre-install-guide/0051-network-plan/topology/0600-nova-topologies.rst deleted file mode 100644 index df6485260..000000000 --- a/pages/pre-install-guide/0051-network-plan/topology/0600-nova-topologies.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. include:: /pages/pre-install-guide/0051-network-plan/topology/nova/0610-nova-topologies.rst -.. include:: /pages/pre-install-guide/0051-network-plan/topology/nova/0620-nova-flatdhcp.rst -.. include:: /pages/pre-install-guide/0051-network-plan/topology/nova/0630-nova-vlan.rst -.. include:: /pages/pre-install-guide/0051-network-plan/topology/nova/0650-nova-assign-networks-to-nics.rst -.. include:: /pages/pre-install-guide/0051-network-plan/topology/nova/0659-nova-net-plan-header.rst -.. include:: /pages/pre-install-guide/0051-network-plan/topology/nova/0660-nova-plan-flatdhcp.rst -.. include:: /pages/pre-install-guide/0051-network-plan/topology/nova/0680-nova-plan-vlan.rst diff --git a/pages/pre-install-guide/0051-network-plan/topology/0700-neutron-topologies.rst b/pages/pre-install-guide/0051-network-plan/topology/0700-neutron-topologies.rst deleted file mode 100644 index 8134fa8b3..000000000 --- a/pages/pre-install-guide/0051-network-plan/topology/0700-neutron-topologies.rst +++ /dev/null @@ -1,7 +0,0 @@ - -.. include:: /pages/pre-install-guide/0051-network-plan/topology/neutron/0710-neutron-topologies.rst -.. include:: /pages/pre-install-guide/0051-network-plan/topology/neutron/0720-neutron-vlan.rst -.. include:: /pages/pre-install-guide/0051-network-plan/topology/neutron/0730-neutron-gre.rst -.. include:: /pages/pre-install-guide/0051-network-plan/topology/neutron/0759.net-plan-header.rst -.. include:: /pages/pre-install-guide/0051-network-plan/topology/neutron/0760-neutron-plan-vlan.rst -.. include:: /pages/pre-install-guide/0051-network-plan/topology/neutron/0780-neutron-plan-gre.rst diff --git a/pages/pre-install-guide/0051-network-plan/topology/0900-routing-req.rst b/pages/pre-install-guide/0051-network-plan/topology/0900-routing-req.rst deleted file mode 100644 index 35fa41e72..000000000 --- a/pages/pre-install-guide/0051-network-plan/topology/0900-routing-req.rst +++ /dev/null @@ -1,30 +0,0 @@ -Routing recommendations ------------------------ - -Consider the following routing recommendations when you configure your -network: - -- Use the default routing via a router in the Public network -- Use the the management network to access to your management - infrastructure (L3 connectivity if necessary) -- The Storage and VM networks should be configured without access to - other networks (no L3 connectivity) - -.. image:: /_images/fuel-network-scheme.jpg - :align: center -.. image:: /_images/grub-screen.png - :align: center -.. image:: /_images/grub-cmdline.png - :align: center -.. image:: /_images/fuel-wizard.png - :align: center -.. image:: /_images/fuel-network-settings.png - :align: center -.. image:: /_images/fuel-settings.png - :align: center -.. image:: /_images/fuel-nodes.png - :align: center -.. image:: /_images/fuel-nodes-selected.png - :align: center -.. image:: /_images/fuel-node-network.png - :align: center diff --git a/pages/pre-install-guide/0051-network-plan/topology/neutron/0710-neutron-topologies.rst b/pages/pre-install-guide/0051-network-plan/topology/neutron/0710-neutron-topologies.rst deleted file mode 100644 index e711dc89a..000000000 --- a/pages/pre-install-guide/0051-network-plan/topology/neutron/0710-neutron-topologies.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _neutron: - -Neutron -------- - -This section describes recommended parameters for network configuration -using the Neutron service. - diff --git a/pages/pre-install-guide/0051-network-plan/topology/neutron/0720-neutron-vlan.rst b/pages/pre-install-guide/0051-network-plan/topology/neutron/0720-neutron-vlan.rst deleted file mode 100644 index 7b21b9993..000000000 --- a/pages/pre-install-guide/0051-network-plan/topology/neutron/0720-neutron-vlan.rst +++ /dev/null @@ -1,12 +0,0 @@ -VLAN Segmentation -~~~~~~~~~~~~~~~~~ - -The following diagram shows the network isolation using Open vSwitches and -VLANs: - -.. image:: /_images/preinstall_d_vlan_segm.jpg - :align: center - :width: 75% - -.. note:: You must have at least three network interfaces for this - configuration diff --git a/pages/pre-install-guide/0051-network-plan/topology/neutron/0730-neutron-gre.rst b/pages/pre-install-guide/0051-network-plan/topology/neutron/0730-neutron-gre.rst deleted file mode 100644 index 646f1934f..000000000 --- a/pages/pre-install-guide/0051-network-plan/topology/neutron/0730-neutron-gre.rst +++ /dev/null @@ -1,14 +0,0 @@ -GRE Segmentation -~~~~~~~~~~~~~~~~ - -The following diagram shows the network segmentation using Open vSwitch -and GRE tunneling. - -.. image:: /_images/preinstall_d_gre_segm.jpg - :align: center - :width: 75% - -Open vSwitch (OVS) GRE tunnels are provided through Management Network. - -.. note:: This setup does not include physical Private network. - diff --git a/pages/pre-install-guide/0051-network-plan/topology/neutron/0759.net-plan-header.rst b/pages/pre-install-guide/0051-network-plan/topology/neutron/0759.net-plan-header.rst deleted file mode 100644 index e35db3d9e..000000000 --- a/pages/pre-install-guide/0051-network-plan/topology/neutron/0759.net-plan-header.rst +++ /dev/null @@ -1,3 +0,0 @@ - -Network Planning Examples -~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/pages/pre-install-guide/0051-network-plan/topology/neutron/0760-neutron-plan-vlan.rst b/pages/pre-install-guide/0051-network-plan/topology/neutron/0760-neutron-plan-vlan.rst deleted file mode 100644 index fd37dd2f5..000000000 --- a/pages/pre-install-guide/0051-network-plan/topology/neutron/0760-neutron-plan-vlan.rst +++ /dev/null @@ -1,39 +0,0 @@ -VLAN Segmentation -^^^^^^^^^^^^^^^^^ - -Depending on the number of NICs you have in your node servers, you can use the -following examples to plan your NIC assignment: - -3 NIC deployment - -- eth0 - untagged port for Administrative network -- eth1 (br-eth1) - port for networks: Public/Floating, Management, - Storage -- eth2 (br-eth2) - port for Private network (where the number of VLANs - depends on the number of tenant networks with a continuous range) - -.. image:: /_images/preinstall_d_vlan_3nics.png - :align: center - :width: 50% - -4 NIC deployment - -- eth0 - port for Administrative network -- eth1 (br-eth1) - port for networks: Public/Floating, Management -- eth2 (br-eth2) - port for Private network, with defined VLAN range - IDs -- eth3 (br-eth1) - port for Storage network - -.. image:: /_images/preinstall_d_vlan_4nics.png - :align: center - :width: 50% - -Routing recommendations - -- Use the default routing via a router in the Public network -- Use the the management network to access to your management - infrastructure (L3 connectivity if necessary) -- The administrative network or only the Fuel server (via dedicated - NIC) should have Internet access -- The Storage and Private network (VLANs) should be configured without - access to other networks (no L3 connectivity) diff --git a/pages/pre-install-guide/0051-network-plan/topology/neutron/0780-neutron-plan-gre.rst b/pages/pre-install-guide/0051-network-plan/topology/neutron/0780-neutron-plan-gre.rst deleted file mode 100644 index a6dab829e..000000000 --- a/pages/pre-install-guide/0051-network-plan/topology/neutron/0780-neutron-plan-gre.rst +++ /dev/null @@ -1,46 +0,0 @@ -GRE Segmentation -^^^^^^^^^^^^^^^^ - -Depdnding on the number of NICs you have in your node servers, you can use the -foldowing examples to plan your NIC assignment: - -2  NIC deployment  - -- eth0 - untagged port for Administrative network -- eth1 (br-eth1) - port for networks: Public/Floating, Management, - Storage - -.. image:: /_images/preinstall_d_gre_2nics.png - :align: center - :width: 50% - -3  NIC deployment  - -- eth0 - untagged port for Administrative network -- eth1 (br-eth1) - port for networks: Public/Floating, Management -- eth2 (br-eth2) - port for Storage network - -.. image:: /_images/preinstall_d_gre_3nics.png - :align: center - :width: 50% - -4  NIC deployment  - -- eth0 - untagged port for Administrative network -- eth1 (br-eth1) - port for Management network -- eth2 (br-eth2) - port for Public/Floating network -- eth3 (br-eth3) - port for Storage network - -.. image:: /_images/preinstall_d_gre_4nics.png - :align: center - :width: 50% - -Routing recommendations - -- Use the default routing via router in the Public network -- Use the management network access to your management infrastructure (L3 - connectivity if necessary) -- The administrative network or only Fuel server (via dedicated NIC) - should have Internet access -- The Storage and Private network (VLANs) should be configured - without access to other networks (no L3 connectivity) diff --git a/pages/pre-install-guide/0051-network-plan/topology/nova/0610-nova-topologies.rst b/pages/pre-install-guide/0051-network-plan/topology/nova/0610-nova-topologies.rst deleted file mode 100644 index f7d2124c8..000000000 --- a/pages/pre-install-guide/0051-network-plan/topology/nova/0610-nova-topologies.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _novanetwork: - -Nova-network ------------- - -Nova-network offers two options for deploying private network for tenants: - -* FlatDHCP Manager -* VLAN Manager - diff --git a/pages/pre-install-guide/0051-network-plan/topology/nova/0650-nova-assign-networks-to-nics.rst b/pages/pre-install-guide/0051-network-plan/topology/nova/0650-nova-assign-networks-to-nics.rst deleted file mode 100644 index e810d1ed9..000000000 --- a/pages/pre-install-guide/0051-network-plan/topology/nova/0650-nova-assign-networks-to-nics.rst +++ /dev/null @@ -1,12 +0,0 @@ -Assigning OpenStack Networks to Network Interfaces -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You must associate each OpenStack network with a server NIC. - -To assign OpenStack networks to server NICs, using Fuel UI: - -1. Click **Add Nodes**. -2. Select the role for this host. -3. Click **Apply Changes**. -4. Select the role you want to modify, and click **Configure Interfaces**. -5. Drag and drop the appropriate networks onto the physical interfaces. diff --git a/pages/pre-install-guide/0051-network-plan/topology/nova/0659-nova-net-plan-header.rst b/pages/pre-install-guide/0051-network-plan/topology/nova/0659-nova-net-plan-header.rst deleted file mode 100644 index dbe6a32a2..000000000 --- a/pages/pre-install-guide/0051-network-plan/topology/nova/0659-nova-net-plan-header.rst +++ /dev/null @@ -1,3 +0,0 @@ -Network Planning Examples -~~~~~~~~~~~~~~~~~~~~~~~~~ - diff --git a/pages/pre-install-guide/0080-reference-configuration/0080-ref-switches-intro.rst b/pages/pre-install-guide/0080-reference-configuration/0080-ref-switches-intro.rst index c937ad061..e03eaa06a 100644 --- a/pages/pre-install-guide/0080-reference-configuration/0080-ref-switches-intro.rst +++ b/pages/pre-install-guide/0080-reference-configuration/0080-ref-switches-intro.rst @@ -1,5 +1,5 @@ Reference configuration of hardware switches --------------------------------------------- +============================================ This section describes reference configuration for Cisco and Juniper network switches. diff --git a/pages/pre-install-guide/0090-appendix/0091-ex-ha-nova-flatdhcp-ports.rst b/pages/pre-install-guide/0090-appendix/0091-ex-ha-nova-flatdhcp-ports.rst index 9672cf031..ae53d12e5 100644 --- a/pages/pre-install-guide/0090-appendix/0091-ex-ha-nova-flatdhcp-ports.rst +++ b/pages/pre-install-guide/0090-appendix/0091-ex-ha-nova-flatdhcp-ports.rst @@ -1,5 +1,5 @@ Detailed Port Configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +--------------------------- The following table describes the detailed port configuration and VLAN assignment. diff --git a/pages/pre-install-guide/0090-appendix/0091-ex-ha-nova-flatdhcp.rst b/pages/pre-install-guide/0090-appendix/0091-ex-ha-nova-flatdhcp.rst index 571a124fc..f87faaa59 100644 --- a/pages/pre-install-guide/0090-appendix/0091-ex-ha-nova-flatdhcp.rst +++ b/pages/pre-install-guide/0090-appendix/0091-ex-ha-nova-flatdhcp.rst @@ -1,5 +1,5 @@ Example 1: HA + Nova-network FlatDHCP manager ---------------------------------------------- +============================================= As a model example, the following configuration is used: diff --git a/pages/pre-install-guide/0090-appendix/0091-nova-switch-cisco-2960g.rst b/pages/pre-install-guide/0090-appendix/0091-nova-switch-cisco-2960g.rst index d63393fc6..6fe32d015 100644 --- a/pages/pre-install-guide/0090-appendix/0091-nova-switch-cisco-2960g.rst +++ b/pages/pre-install-guide/0090-appendix/0091-nova-switch-cisco-2960g.rst @@ -1,7 +1,7 @@ -.. _cisco-2960g-config: +.. _cisco-2960g-nova: -Switch configuration (Cisco Catalyst 2960G) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Nova-network Switch configuration (Cisco Catalyst 2960G) +-------------------------------------------------------- Use the following configuration to deploy Mirantis OpenStack using a Cisco Catalyst 2960G network switch.:: diff --git a/pages/pre-install-guide/0090-appendix/0091-nova-switch-juniper-ex4200.rst b/pages/pre-install-guide/0090-appendix/0091-nova-switch-juniper-ex4200.rst index d38de49db..d3f79979c 100644 --- a/pages/pre-install-guide/0090-appendix/0091-nova-switch-juniper-ex4200.rst +++ b/pages/pre-install-guide/0090-appendix/0091-nova-switch-juniper-ex4200.rst @@ -1,5 +1,8 @@ -Switch configuration (Juniper EX4200) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. _juniper-ex4200-nova: + +Nova-network Switch configuration (Juniper EX4200) +-------------------------------------------------- Use the following configuration to deploy Mirantis OpenStack using Juniper EX4200 network switch.:: diff --git a/pages/pre-install-guide/0090-appendix/0095-ex-ha-neutron-gre-ports.rst b/pages/pre-install-guide/0090-appendix/0095-ex-ha-neutron-gre-ports.rst index 7faabcc39..df19c6788 100644 --- a/pages/pre-install-guide/0090-appendix/0095-ex-ha-neutron-gre-ports.rst +++ b/pages/pre-install-guide/0090-appendix/0095-ex-ha-neutron-gre-ports.rst @@ -1,5 +1,5 @@ Detailed port configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +--------------------------- The following table describes port configuration for this deployment. diff --git a/pages/pre-install-guide/0090-appendix/0095-ex-ha-neutron-gre.rst b/pages/pre-install-guide/0090-appendix/0095-ex-ha-neutron-gre.rst index c3301664c..7e6a741bd 100644 --- a/pages/pre-install-guide/0090-appendix/0095-ex-ha-neutron-gre.rst +++ b/pages/pre-install-guide/0090-appendix/0095-ex-ha-neutron-gre.rst @@ -1,5 +1,6 @@ Example 2: HA + Neutron with GRE --------------------------------- +================================ + As a model example, the following configuration is used: * **Deploying mode:** Multi-node HA diff --git a/pages/pre-install-guide/0090-appendix/0095-neutron-switch-cisco-2960g.rst b/pages/pre-install-guide/0090-appendix/0095-neutron-switch-cisco-2960g.rst index d0ab75304..3b2ddbfa4 100644 --- a/pages/pre-install-guide/0090-appendix/0095-neutron-switch-cisco-2960g.rst +++ b/pages/pre-install-guide/0090-appendix/0095-neutron-switch-cisco-2960g.rst @@ -1,5 +1,8 @@ -Switch configuration (Cisco Catalyst 2960G) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. _cisco-2960g-neutron: + +Neutron Switch configuration (Cisco Catalyst 2960G) +--------------------------------------------------- Use the following configuration to deploy Mirantis OpenStack using a Cisco Catalyst 2960G network switch. diff --git a/pages/pre-install-guide/0090-appendix/0095-neutron-switch-juniper-ex4200.rst b/pages/pre-install-guide/0090-appendix/0095-neutron-switch-juniper-ex4200.rst index c5493e516..251665b8b 100644 --- a/pages/pre-install-guide/0090-appendix/0095-neutron-switch-juniper-ex4200.rst +++ b/pages/pre-install-guide/0090-appendix/0095-neutron-switch-juniper-ex4200.rst @@ -1,5 +1,8 @@ -Switch configuration (Juniper EX4200) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. _juniper-ex4200-neutron: + +Neutron Switch configuration (Juniper EX4200) +--------------------------------------------- Use the following configuration to deploy Mirantis OpenStack using Juniper EX4200 network switch. diff --git a/pages/pre-install-guide/4000-planning-summary.rst b/pages/pre-install-guide/4000-planning-summary.rst new file mode 100644 index 000000000..071f408a0 --- /dev/null +++ b/pages/pre-install-guide/4000-planning-summary.rst @@ -0,0 +1,46 @@ +.. _calculator: https://www.mirantis.com/openstack-services/bom-calculator/ + +.. index:: Preparing for the Mirantis OpenStack Deployment + +.. _planning-summary: + +Planning Summary +================ + +Before installation, plan your deployment. Determine the deployment type that +is appropriate for you configuration needs. You may want to print this +list and make notes indicating your selection so you can be sure +you have planned your deployment correctly. + +The following table provides a list of configuration steps that you must +complete to plan the Mirantis OpenStack deployment. + ++----------------------------+-------------------------------------------+ +| Step Description | Additional Information | ++============================+===========================================+ +| Choose a deployment mode | See :ref:`mode-ha-plan` | +| and whether or not to | | +| deploy high availability | | ++----------------------------+-------------------------------------------+ +| Select a network topology | See :ref:`net-topology-plan` | +| | | ++----------------------------+-------------------------------------------+ +| Choose the Linux distro | See :ref:`linux-distro-plan` | +| to use on your nodes | | ++----------------------------+-------------------------------------------+ +| Determine how many nodes | See :ref:`nodes-roles-plan` | +| to deploy and which roles | | +| to assign to each | | ++----------------------------+-------------------------------------------+ +| Calculate the server and | See :ref:`hardware-plan` | +| network hardware needed | | ++----------------------------+-------------------------------------------+ +| Prepare an IP address | Identify the network addresses and VLAN | +| management plan and | IDs for your Public, floating, Management,| +| network association. | Storage, and virtual machine (fixed) | +| | networks. | ++----------------------------+-------------------------------------------+ +| Prepare a logical network | | +| diagram. | | ++----------------------------+-------------------------------------------+ + diff --git a/pages/pre-install-guide/4100-mode-ha.rst b/pages/pre-install-guide/4100-mode-ha.rst new file mode 100644 index 000000000..12a4552f7 --- /dev/null +++ b/pages/pre-install-guide/4100-mode-ha.rst @@ -0,0 +1,5 @@ + +.. _mode-ha-plan: + +Choose Deployment Mode and High Availability +============================================ diff --git a/pages/pre-install-guide/4200-net-topology.rst b/pages/pre-install-guide/4200-net-topology.rst new file mode 100644 index 000000000..d095c3caf --- /dev/null +++ b/pages/pre-install-guide/4200-net-topology.rst @@ -0,0 +1,62 @@ + +.. _net-topology-plan: + +Choose Network Topology +======================= + +OpenStack supports two network modes, +each of which supports two topologies. +For architectural descriptions of the four topologies, see: + +* :ref:`neutron-vlan-ovs-arch` +* :ref:`neutron-gre-ovs-arch` +* :ref:`nova-flatdhcp-arch` +* :ref:`nova-vlan-arch` + +**Nova-network** is a simple legacy network manager. +It can operate with predefined Private IP spaces only. + +* If you do not want to split your VMs to an isolated groups (tenants), + you can choose the **Nova-network with FlatDHCP topology**. + In this case, you will have one big tenant for all VMs. + +* If you want use multiple tenants + and all of them contain approximately the same number of VMs, + you can use the **Nova-network with VLANManager topology**. + In this case, the number of the tenants is predefined + and all the tenants have equal amount of Private IP space. + You must decide about these two numbers + (max number of tenants and Private IP space size) + before starting deployment. + Also, you must set up appropriate VLANs + on your underlying network equipment. + +**Neutron** is a modern and more complicated network manager. +It can not only separate tenants +but it decreases the requirements for the underlying network +(physical switches and topology) +and gives a great deal of flexibility +for manipulating Private IP spaces. +You can create Private IP spaces with different sizes +and manipulate them on the fly. + +* The **Neutron with VLAN topology**, + like Nova-network with VLANManager, + requires a predefined maximum number of tenants value + and underlying network equipment configuration. + +* The **Neutron with GRE** topology + does not restrict the maximum number of VLANs + and you can spawn a very large number of tenants. + But GRE encapsulation decreases the speed of comminication between the VMs + and decreases the CPU utilization of the Compute and Controller nodes. + So, if you do not need really fast interconnections between VMs, + do not want to predetermine the maximum number of tenants, + and do not want to configure your network equipment, + you can choose the Neutron + GRE topology. + +Some other considerations when choosing a network topology: + +- :ref:`ovs-term` and :ref:`bonding-term` can only be implemented on Neutron. +- VMWare vCenter can only be implemented on Nova-network. +- Murano is supported only on Neutron. diff --git a/pages/pre-install-guide/4300-linux-distro.rst b/pages/pre-install-guide/4300-linux-distro.rst new file mode 100644 index 000000000..72e32da45 --- /dev/null +++ b/pages/pre-install-guide/4300-linux-distro.rst @@ -0,0 +1,25 @@ + +.. _linux-distro-plan: + +Linux Distribution for Nodes +============================ + +Fuel allows you to deploy either the CentOS or Ubuntu +Linux distribution as the Host O/S on the nodes. +All nodes in the environment must run the same Linux distribution. +Often, the choice is made based on personal preference; +many administrative tasks on the nodes +must be performed at shell level +and many people choose the distribution +with which they are most comfortable. + +Some specific considerations: + +- Each distribution has some hardware support issues. + See :ref:`release-notes` for details about known issues. +- In particular, the CentOS version used for OpenStack + does not include native support for VLANs + while the Ubuntu version does. + In order to use VLANs on CentOS based nodes, + you must configure VLAN splinters. +- CentOS supports .rpm packages; Ubuntu supports .deb packages. diff --git a/pages/reference-architecture/0030-cluster-sizing.rst b/pages/pre-install-guide/4400-nodes-roles.rst similarity index 59% rename from pages/reference-architecture/0030-cluster-sizing.rst rename to pages/pre-install-guide/4400-nodes-roles.rst index b5c604e0a..0cd16d34a 100644 --- a/pages/reference-architecture/0030-cluster-sizing.rst +++ b/pages/pre-install-guide/4400-nodes-roles.rst @@ -1,16 +1,39 @@ + + .. raw:: pdf PageBreak -.. index:: Cluster Sizing +.. _nodes-roles-plan: -Cluster Sizing -============== +Nodes and Roles +=============== -This reference architecture is well suited for production-grade -OpenStack deployments on a medium and large scale when you can afford -allocating several servers for your OpenStack controller nodes in -order to build a fully redundant and highly available environment. +Your OpenStack environment contains a set of +specialized nodes and roles; +see :ref:`nodes-roles-arch` for a description. +When planning your OpenStack deployment, +you must determine the proper mix of node types +and what roles will be installed on each. + +Some general guiding principles: + +- When deploying a production-grade OpenStack environment, + it is best to spread the roles (and, hence, the workload) + over as many servers as possible + in order to have a fully redundant, highly-available OpenStack environment + and to avoid performance bottlenecks. +- For demonstration and study purposes, + you can deploy OpenStack on VirtualBox; + see :ref:`virtualbox` for more information. + This option has the lowest hardware requirements +- OpenStack can be deployed on smaller hardware configurations + by combining multiple roles on the nodes + and mapping multiple :ref:`logical-networks-arch` + to a single physical NIC. + +This section provides information to help you decide +how many nodes you need and which roles to assign to each. The absolute minimum requirement for a highly-available OpenStack deployment is to allocate 4 nodes: diff --git a/pages/pre-install-guide/4500-hardware.rst b/pages/pre-install-guide/4500-hardware.rst new file mode 100644 index 000000000..0e4571244 --- /dev/null +++ b/pages/pre-install-guide/4500-hardware.rst @@ -0,0 +1,5 @@ + +.. _hardware-plan: + +Calculate hardware requirements +=============================== diff --git a/pages/reference-architecture/0010-overview.rst b/pages/reference-architecture/0010-overview.rst index b520c2822..79b2f3ef4 100644 --- a/pages/reference-architecture/0010-overview.rst +++ b/pages/reference-architecture/0010-overview.rst @@ -4,6 +4,8 @@ .. index Reference Architectures +.. _nodes-roles-arch: + OpenStack Environment Architecture ================================== diff --git a/pages/reference-architecture/6000-network-architecture.rst b/pages/reference-architecture/6000-network-architecture.rst index 8c35786ca..33fc11510 100644 --- a/pages/reference-architecture/6000-network-architecture.rst +++ b/pages/reference-architecture/6000-network-architecture.rst @@ -14,9 +14,12 @@ Logical Networks For better network performance and manageability, Fuel places different types of traffic into separate logical networks. -his section describes how to distribute +This section describes how to distribute the network traffic in an OpenStack cluster. +Refer to :ref:`User_Guide` for instructions on how to configure network for +your OpenStack environment. + .. index:: Admin (PXE) Network Admin (PXE) Network ("Fuel network") diff --git a/pages/reference-architecture/6030-router.rst b/pages/reference-architecture/6030-router.rst new file mode 100644 index 000000000..a915ac3f0 --- /dev/null +++ b/pages/reference-architecture/6030-router.rst @@ -0,0 +1,32 @@ + +.. _router-plan: + +Router +------ + +Your network must have an IP address set on a router +in the Public :ref:`logical-networks-arch`. +Without this, your VMs are unable to access the outside world. +In many of the examples provided in these documents, +that IP is 12.0.0.1 in VLAN 101. + +The Fuel UI includes a field on the networking tab for the gateway address. +When OpenStack deployment starts, +the network on each node is reconfigured +to use this gateway IP address as the default gateway. + +If Floating addresses are from another L3 network, +then you must configure the IP address +(or multiple IPs if Floating addresses are from more than one L3 network) +for them on the router as well. +Otherwise, Floating IPs on nodes will be inaccessible. + +Consider the following routing recommendations +when you configure your network: + +- Use the default routing via a router in the Public network +- Use the the management network to access your management + infrastructure (L3 connectivity if necessary) +- The Storage and VM networks should be configured without access to + other networks (no L3 connectivity) + diff --git a/pages/reference-architecture/6034-switch.rst b/pages/reference-architecture/6034-switch.rst new file mode 100644 index 000000000..3db6bd0ed --- /dev/null +++ b/pages/reference-architecture/6034-switch.rst @@ -0,0 +1,107 @@ + +.. _switch-plan: + +Switches +-------- + +You must manually configure your switches +before deploying your OpenStack environment. +Unfortunately the set of configuration steps, and even the terminology used, +is different for different vendors; +this section provides some vendor-agnostic information +about how traffic should flow. +We also provide sample switch configurations: + +* :ref:`cisco-2960g-nova` +* :ref:`juniper-ex4200-nova` +* :ref:`cisco-2960g-neutron` +* :ref:`juniper-ex4200-neutron` + +To configure your switches: + +* Configure all access ports to allow non-tagged PXE booting connections + from each slave node to the Fuel Master node. + This network is referred to as the Fuel network. + +* By default, the Fuel Master node uses the `eth0` interface + to serve PXE requests on this network, + but this can be changed :ref:`during installation ` + of the Fuel Master node. + +* If you use the `eth0` interface for PXE requests, + you must set the switch port for `eth0` on the Fuel Master node + to access mode. + +* We recommend that you use the `eth0` interfaces of all other nodes + for PXE booting as well. + Corresponding ports must also be in access mode. + +* Taking into account that this is the network for PXE booting, + do not mix this L2 segment with any other network segments. + Fuel runs a DHCP server, and, + if there is another DHCP on the same L2 network segment, + both the company's infrastructure and Fuel's + are unable to function properly. + +* You must also configure each of the switch's ports + connected to nodes as an "STP Edge port" + (or a "spanning-tree port fast trunk", according to Cisco terminology). + If you do not do that, DHCP timeout issues may occur. + +As long as the Fuel network is configured, Fuel can operate. +Other networks are required for OpenStack environments, +and currently all of these networks live in VLANs +over the one or multiple physical interfaces on a node. +This means that the switch should pass tagged traffic, +and untagging is done on the Linux hosts. + +.. note:: For the sake of simplicity, all the VLANs specified on the networks tab of + the Fuel UI should be configured on switch ports, pointing to Slave nodes, + as tagged. + +Of course, it is possible to specify as tagged +only certain ports for certain nodes. +However, in the current version, +all existing networks are automatically allocated for each node, +with any role. +And network check also checks if tagged traffic can pass, +even if some nodes do not require this check. +for example, Cinder nodes do not need fixed network traffic) + +This is enough to deploy the OpenStack environment. +However, from a practical standpoint, +it is still not really usable +because there is no connection to other corporate networks yet. +To make that possible, you must configure uplink port(s). + +One of the VLANs may carry the office network. +To provide access to the Fuel Master node from your network, +any other free physical network interface +on the Fuel Master node can be used +and configured according to your network rules (static IP or DHCP). +The same network segment can be used for Public and Floating ranges. +In this case, you must provide +the corresponding VLAN ID and IP ranges in the UI. +One Public IP per node is used to SNAT traffic out of the VMs network, +and one or more floating addresses per VM instance +are used to get access to the VM from your network, +or even the global Internet. +To have a VM visible from the Internet is similar +to having it visible from corporate network - +corresponding IP ranges and VLAN IDs must be specified +for the Floating and Public networks. +One current limitation of Fuel +is that the user must use the same L2 segment +for both Public and Floating networks. + +Example configuration for one of the ports on a Cisco switch:: + + interface GigabitEthernet0/6 # switch port + description s0_eth0 jv # description + switchport trunk encapsulation dot1q # enables VLANs + switchport trunk native vlan 262 # access port, untags VLAN 262 + switchport trunk allowed vlan 100,102,104 # 100,102,104 VLANs are passed with tags + switchport mode trunk # To allow more than 1 VLAN on the port + spanning-tree portfast trunk # STP Edge port to skip network loop + # checks (to prevent DHCP timeout issues) + vlan 262,100,102,104 # Might be needed for enabling VLANs diff --git a/pages/reference-architecture/6050-neutron-topologies.rst b/pages/reference-architecture/6050-neutron-topologies.rst index 720acd0a4..0e93277e7 100644 --- a/pages/reference-architecture/6050-neutron-topologies.rst +++ b/pages/reference-architecture/6050-neutron-topologies.rst @@ -31,6 +31,9 @@ to act as a virtual Neutron router in HA (if deploying in HA mode). .. include:: /pages/reference-architecture/neutron-intro/0200-neutron-tech-intro.rst +.. include:: /pages/reference-architecture/neutron-intro/0210-vlan.rst +.. include:: /pages/reference-architecture/neutron-intro/0220-gre.rst +.. include:: /pages/reference-architecture/neutron-intro/0260-neutron-config.rst .. include:: /pages/reference-architecture/neutron-intro/0300-neutron-limits.rst -.. include:: /pages/reference-architecture/network-setup/0500-nic-usage.rst +.. include:: /pages/reference-architecture/neutron-intro/0500-nic-usage.rst diff --git a/pages/reference-architecture/6070-nova-topologies.rst b/pages/reference-architecture/6070-nova-topologies.rst new file mode 100644 index 000000000..dfa50a68c --- /dev/null +++ b/pages/reference-architecture/6070-nova-topologies.rst @@ -0,0 +1,17 @@ + +.. _nova-topologies-arch: + +Nova Network Topologies +======================= + +Nova-network offers two options for deploying private network for tenants: + +* FlatDHCP Manager +* VLAN Manager + + +This section describes the Nova-network topologies. + +.. include:: /pages/reference-architecture/nova-intro/0620-nova-flatdhcp.rst +.. include:: /pages/reference-architecture/nova-intro/0630-nova-vlan.rst +.. include:: /pages/reference-architecture/nova-intro/0659-nova-net-plan.rst diff --git a/pages/reference-architecture/neutron-intro/0200-neutron-tech-intro.rst b/pages/reference-architecture/neutron-intro/0200-neutron-tech-intro.rst index a2c8999f8..572682c55 100644 --- a/pages/reference-architecture/neutron-intro/0200-neutron-tech-intro.rst +++ b/pages/reference-architecture/neutron-intro/0200-neutron-tech-intro.rst @@ -33,32 +33,5 @@ It is important to note: separate NIC to ensure that traffic is separated adequately. * Admin and Private networks must be located together on a NIC that is separate from the other networks. - -A typical network configuration for Neutron with VLAN segmentation might look -like this: - -.. image:: /_images/Neutron_32_vlan_v2.png - :align: center - - -A typical network configuration for Neutron with GRE segmentation might look -like this: - -.. image:: /_images/Neutron_32_gre_v2.png - :align: center - -The most likely configuration for different number NICs on cluster nodes: - -+------+--------------------------------------+--------------------------------------+ -| NICs | VLAN | GRE | -+======+======================================+======================================+ -| 2 | Not supported | .. image:: /_images/q32_gre_2nic.* | -| | | :align: center | -+------+--------------------------------------+--------------------------------------+ -| 3 | .. image:: /_images/q32_vlan_3nic.* | .. image:: /_images/q32_gre_3nic.* | -| | :align: center | :align: center | -+------+--------------------------------------+--------------------------------------+ -| 4 | .. image:: /_images/q32_vlan_4nic.* | .. image:: /_images/q32_gre_4nic.* | -| | :align: center | :align: center | -+------+--------------------------------------+--------------------------------------+ - +* :ref:`ovs-term` improves the flexiblity and performance + of both Neutron topologies. diff --git a/pages/reference-architecture/neutron-intro/0210-vlan.rst b/pages/reference-architecture/neutron-intro/0210-vlan.rst new file mode 100644 index 000000000..132092b42 --- /dev/null +++ b/pages/reference-architecture/neutron-intro/0210-vlan.rst @@ -0,0 +1,16 @@ + +.. _neutron-vlan-ovs-arch: + +Neutron with VLAN segmentation and OVS +++++++++++++++++++++++++++++++++++++++ + +The following diagram shows the network isolation +using :ref:`ovs-term` and VLANs: + + +.. image:: /_images/Neutron_32_vlan_v2.png + :width: 90% + +.. note:: You must have at least three network interfaces for this + configuration + diff --git a/pages/reference-architecture/neutron-intro/0220-gre.rst b/pages/reference-architecture/neutron-intro/0220-gre.rst new file mode 100644 index 000000000..bd4164aa3 --- /dev/null +++ b/pages/reference-architecture/neutron-intro/0220-gre.rst @@ -0,0 +1,17 @@ + +.. _neutron-gre-ovs-arch: + +Neutron with GRE segmentation and OVS +++++++++++++++++++++++++++++++++++++++ + +A typical network configuration for Neutron with GRE segmentation might look +like this: + +.. image:: /_images/Neutron_32_gre_v2.png + :width: 90% + +Open vSwitch (OVS) GRE tunnels are provided through Management Network. + +.. note:: This setup does not include physical Private network. + + diff --git a/pages/reference-architecture/neutron-intro/0260-neutron-config.rst b/pages/reference-architecture/neutron-intro/0260-neutron-config.rst new file mode 100644 index 000000000..23c0343fa --- /dev/null +++ b/pages/reference-architecture/neutron-intro/0260-neutron-config.rst @@ -0,0 +1,111 @@ + +.. _neutron-config-gen: + +Neutron Configuration Planning -- General ++++++++++++++++++++++++++++++++++++++++++ + +The most likely configuration for different number NICs on cluster nodes: + ++------+--------------------------------------+--------------------------------------+ +| NICs | VLAN | GRE | ++======+======================================+======================================+ +| 2 | Not supported | .. image:: /_images/q32_gre_2nic.* | +| | | :align: center | ++------+--------------------------------------+--------------------------------------+ +| 3 | .. image:: /_images/q32_vlan_3nic.* | .. image:: /_images/q32_gre_3nic.* | +| | :align: center | :align: center | ++------+--------------------------------------+--------------------------------------+ +| 4 | .. image:: /_images/q32_vlan_4nic.* | .. image:: /_images/q32_gre_4nic.* | +| | :align: center | :align: center | ++------+--------------------------------------+--------------------------------------+ + +.. _neutron-config-vlan: + +Neutron VLAN Segmentation Planning +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Depending on the number of NICs you have in your node servers, you can use the +following examples to plan your NIC assignment: + +3 NIC deployment + +- eth0 - untagged port for Administrative network +- eth1 (br-eth1) - port for networks: Public/Floating, Management, + Storage +- eth2 (br-eth2) - port for Private network (where the number of VLANs + depends on the number of tenant networks with a continuous range) + +.. image:: /_images/preinstall_d_vlan_3nics.png + :align: center + :width: 50% + +4 NIC deployment + +- eth0 - port for Administrative network +- eth1 (br-eth1) - port for networks: Public/Floating, Management +- eth2 (br-eth2) - port for Private network, with defined VLAN range + IDs +- eth3 (br-eth1) - port for Storage network + +.. image:: /_images/preinstall_d_vlan_4nics.png + :align: center + :width: 50% + +Routing recommendations + +- Use the default routing via a router in the Public network +- Use the the management network to access to your management + infrastructure (L3 connectivity if necessary) +- The administrative network or only the Fuel server (via dedicated + NIC) should have Internet access +- The Storage and Private network (VLANs) should be configured without + access to other networks (no L3 connectivity) + +.. _neutron-config-gre: + +Neutron GRE Segmentation Planning +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Depdnding on the number of NICs you have in your node servers, you can use the +foldowing examples to plan your NIC assignment: + +2  NIC deployment  + +- eth0 - untagged port for Administrative network +- eth1 (br-eth1) - port for networks: Public/Floating, Management, + Storage + +.. image:: /_images/preinstall_d_gre_2nics.png + :align: center + :width: 50% + +3  NIC deployment  + +- eth0 - untagged port for Administrative network +- eth1 (br-eth1) - port for networks: Public/Floating, Management +- eth2 (br-eth2) - port for Storage network + +.. image:: /_images/preinstall_d_gre_3nics.png + :align: center + :width: 50% + +4  NIC deployment  + +- eth0 - untagged port for Administrative network +- eth1 (br-eth1) - port for Management network +- eth2 (br-eth2) - port for Public/Floating network +- eth3 (br-eth3) - port for Storage network + +.. image:: /_images/preinstall_d_gre_4nics.png + :align: center + :width: 50% + +Routing recommendations + +- Use the default routing via router in the Public network +- Use the management network access to your management infrastructure (L3 + connectivity if necessary) +- The administrative network or only Fuel server (via dedicated NIC) + should have Internet access +- The Storage and Private network (VLANs) should be configured + without access to other networks (no L3 connectivity) diff --git a/pages/reference-architecture/network-setup/0500-nic-usage.rst b/pages/reference-architecture/neutron-intro/0500-nic-usage.rst similarity index 100% rename from pages/reference-architecture/network-setup/0500-nic-usage.rst rename to pages/reference-architecture/neutron-intro/0500-nic-usage.rst diff --git a/pages/pre-install-guide/0051-network-plan/topology/nova/0620-nova-flatdhcp.rst b/pages/reference-architecture/nova-intro/0620-nova-flatdhcp.rst similarity index 50% rename from pages/pre-install-guide/0051-network-plan/topology/nova/0620-nova-flatdhcp.rst rename to pages/reference-architecture/nova-intro/0620-nova-flatdhcp.rst index be22d2435..44bbda31a 100644 --- a/pages/pre-install-guide/0051-network-plan/topology/nova/0620-nova-flatdhcp.rst +++ b/pages/reference-architecture/nova-intro/0620-nova-flatdhcp.rst @@ -1,5 +1,9 @@ -FlatDHCP Manager Network Diagram -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +.. _nova-flatdhcp-arch: + +Nova-network FlatDHCP Manager Network Diagram +--------------------------------------------- The following diagram describes network configuration when you use Nova-network with FlatDHCP Manager: @@ -8,5 +12,5 @@ Nova-network with FlatDHCP Manager: :align: center :width: 75% -For more information about FlatDHCP Manager, see :ref:`Reference Architecture`. +For more information about FlatDHCP Manager, see :ref:`ref-arch`. diff --git a/pages/pre-install-guide/0051-network-plan/topology/nova/0630-nova-vlan.rst b/pages/reference-architecture/nova-intro/0630-nova-vlan.rst similarity index 62% rename from pages/pre-install-guide/0051-network-plan/topology/nova/0630-nova-vlan.rst rename to pages/reference-architecture/nova-intro/0630-nova-vlan.rst index 30ef7637a..0967d9a40 100644 --- a/pages/pre-install-guide/0051-network-plan/topology/nova/0630-nova-vlan.rst +++ b/pages/reference-architecture/nova-intro/0630-nova-vlan.rst @@ -1,5 +1,9 @@ -VLAN Manager Network Diagram -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +.. _nova-vlan-arch: + +Nova-network VLAN Manager Network Diagram +----------------------------------------- The following diagram describes network configuration when you use Nova-network with VLAN Manager: diff --git a/pages/reference-architecture/nova-intro/0659-nova-net-plan.rst b/pages/reference-architecture/nova-intro/0659-nova-net-plan.rst new file mode 100644 index 000000000..29cdad943 --- /dev/null +++ b/pages/reference-architecture/nova-intro/0659-nova-net-plan.rst @@ -0,0 +1,6 @@ +Nova-network Planning Examples +------------------------------ + +.. include:: /pages/reference-architecture/nova-intro/0660-nova-plan-flatdhcp.rst +.. include:: /pages/reference-architecture/nova-intro/0680-nova-plan-vlan.rst + diff --git a/pages/pre-install-guide/0051-network-plan/topology/nova/0660-nova-plan-flatdhcp.rst b/pages/reference-architecture/nova-intro/0660-nova-plan-flatdhcp.rst similarity index 96% rename from pages/pre-install-guide/0051-network-plan/topology/nova/0660-nova-plan-flatdhcp.rst rename to pages/reference-architecture/nova-intro/0660-nova-plan-flatdhcp.rst index c67e4012f..9ea9d48ad 100644 --- a/pages/pre-install-guide/0051-network-plan/topology/nova/0660-nova-plan-flatdhcp.rst +++ b/pages/reference-architecture/nova-intro/0660-nova-plan-flatdhcp.rst @@ -1,5 +1,5 @@ -FlatDHCP -^^^^^^^^ +Nova-network FlatDHCP ++++++++++++++++++++++ Depending on the number of NICs you have in your node servers, you can use the following examples to plan your NIC assignment: diff --git a/pages/pre-install-guide/0051-network-plan/topology/nova/0680-nova-plan-vlan.rst b/pages/reference-architecture/nova-intro/0680-nova-plan-vlan.rst similarity index 97% rename from pages/pre-install-guide/0051-network-plan/topology/nova/0680-nova-plan-vlan.rst rename to pages/reference-architecture/nova-intro/0680-nova-plan-vlan.rst index 8ae4f8f08..51cbce83d 100644 --- a/pages/pre-install-guide/0051-network-plan/topology/nova/0680-nova-plan-vlan.rst +++ b/pages/reference-architecture/nova-intro/0680-nova-plan-vlan.rst @@ -1,5 +1,5 @@ -VLAN Manager -^^^^^^^^^^^^ +Nova-network VLAN Manager ++++++++++++++++++++++++++ Depending on the number of NICs you have in your node servers, you can use the following examples to plan your NIC assignment: diff --git a/pages/reference-architecture/ovs/0230-cli-transformation.rst b/pages/reference-architecture/ovs/0230-cli-transformation.rst index dd5f8acfd..efe23d7a8 100644 --- a/pages/reference-architecture/ovs/0230-cli-transformation.rst +++ b/pages/reference-architecture/ovs/0230-cli-transformation.rst @@ -22,9 +22,10 @@ Here are the the available options: "action": "add-port", # type of primitive "name": "xxx-port", # unique name of the new port "bridge": "xxx", # name of the bridge where the port should be created - "type": "internal", # [optional; default: "internal"] a type of OVS interface - # for the port (see OVS documentation); - # possible values: "system", "internal", "tap", "gre", "null" + "type": "internal", # [optional; default: "internal"] a type of OVS + # interface # for the port (see OVS documentation); + # possible values: + # "system", "internal", "tap", "gre", "null" "tag": 0, # [optional; default: 0] a 802.1q tag of traffic that # should be captured from an OVS bridge; # possible values: 0 (means port is a trunk), @@ -62,8 +63,9 @@ Here are the the available options: # tag passes); e.g. [0,10,20] "properties": [], # [optional; default: []] a list of additional # OVS bonded port properties to modify them in OVS DB; - # you can use it to set the aggregation mode and balancing - # strategy, to configure LACP, and so on (see the OVS documentation) + # you can use it to set the aggregation mode and + # balancing # strategy, to configure LACP, and so on + # (see the OVS documentation) }, { "action": "add-patch", # type of primitive diff --git a/pages/release-notes/v5-0-icehouse-full.rst b/pages/release-notes/v5-0-icehouse-full.rst index 8241ed0de..a829aabf6 100644 --- a/pages/release-notes/v5-0-icehouse-full.rst +++ b/pages/release-notes/v5-0-icehouse-full.rst @@ -1,5 +1,5 @@ -.. _RelNotes_50: +.. _RelNotes-5-0: Release Notes for Mirantis OpenStack 5.0 diff --git a/pdf/conf.py b/pdf/conf.py index 2defd2f9c..dca8604a1 100644 --- a/pdf/conf.py +++ b/pdf/conf.py @@ -17,7 +17,7 @@ execfile('../common_conf.py') exclude_patterns = ['_*', "pages", 'relnotes', 'contents', 'index', '*-guide', '*.rst'] pdf_documents = [ - ('pdf/pdf_preinstall', u'Mirantis-OpenStack-5.0-Pre-InstallationGuide', u'Pre-Installation Guide', u'2014, Mirantis Inc.'), + ('pdf/pdf_preinstall', u'Mirantis-OpenStack-5.0-PlanningGuide', u'Planning Guide', u'2014, Mirantis Inc.'), ('pdf/pdf_install', u'Mirantis-OpenStack-5.0-InstallGuide', u'Installation Guide', u'2014, Mirantis Inc.'), ('pdf/pdf_user', u'Mirantis-OpenStack-5.0-UserGuide', u'User Guide', u'2014, Mirantis Inc.'), ('pdf/pdf_operations', u'Mirantis-OpenStack-5.0-OperationsGuide', u'Operations Guide', u'2014, Mirantis Inc.'), diff --git a/pdf/pdf_preinstall.rst b/pdf/pdf_preinstall.rst index c8dbc658e..fe14998ff 100644 --- a/pdf/pdf_preinstall.rst +++ b/pdf/pdf_preinstall.rst @@ -5,7 +5,7 @@ +-------------------------------------+-----------------------------------+ | Mirantis OpenStack v5.0 | .. cssclass:: right| | | | - | Pre-Installation Guide | ###Section### | + | Planning Guide | ###Section### | +-------------------------------------+-----------------------------------+ .. footer:: diff --git a/pre-install-guide.rst b/pre-install-guide.rst index 65bd1e674..07129d6ee 100644 --- a/pre-install-guide.rst +++ b/pre-install-guide.rst @@ -1,10 +1,10 @@ -.. index:: Pre-install Guide +.. index:: Planning Guide -.. _Pre-install_Guide: +.. _planning-guide: -====================== -Pre-Installation Guide -====================== +============== +Planning Guide +============== .. contents:: :local: :depth: 3 diff --git a/release-notes.rst b/release-notes.rst index 697a4a1f6..acfbb7e2d 100644 --- a/release-notes.rst +++ b/release-notes.rst @@ -1,6 +1,5 @@ .. index:: Release Notes - -.. _Release_Notes: +.. _release-notes: ============= Release Notes