Updates to user guide
Change-Id: Ifb20726f37060438a4954715f5d549d708781bcf Signed-off-by: Illia Polliul <ipolliul@mirantis.com>
@ -28,10 +28,10 @@ source_suffix = '.rst'
|
||||
master_doc = 'index'
|
||||
|
||||
project = u'Contrail plugin for Fuel'
|
||||
copyright = u'2015, Mirantis Inc.'
|
||||
copyright = u'2016, Mirantis Inc.'
|
||||
|
||||
version = '4.0-4.0.0-1'
|
||||
release = '4.0-4.0.0-1'
|
||||
version = '5.0-5.0.0-1'
|
||||
release = '5.0-5.0.0-1'
|
||||
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
Contrail TSN (experimental)
|
||||
===========================
|
||||
Contrail TSN
|
||||
============
|
||||
|
||||
|
||||
TSN Description
|
||||
|
@ -70,8 +70,6 @@ To configure DPDK you should proceed with the following steps:
|
||||
|
||||
#. Enable the Contrail plugin in Fuel web UI settings
|
||||
|
||||
.. image:: images/enable_contrail_plugin.png
|
||||
|
||||
.. raw:: latex
|
||||
|
||||
\pagebreak
|
||||
@ -80,11 +78,13 @@ To configure DPDK you should proceed with the following steps:
|
||||
|
||||
.. image:: images/enable_contrail_dpdk.png
|
||||
|
||||
#. Choose the size and amount of huge pages to allocate. They will be used for
|
||||
#. Choose the size and amount of huge pages to allocate for each Compute. They will be used for
|
||||
both vRouter process and VMs backing. 2MB sized huge pages can be added on-fly,
|
||||
1GB sized require a reboot. Also, leave some amount of memory
|
||||
for the operating system itself.
|
||||
|
||||
.. image:: images/huge_pages.png
|
||||
|
||||
.. raw:: latex
|
||||
|
||||
\pagebreak
|
||||
|
@ -1,5 +1,5 @@
|
||||
DPDK-based vRouter on virtual function (VF) (experimental)
|
||||
==========================================================
|
||||
DPDK-based vRouter on virtual function (VF)
|
||||
===========================================
|
||||
|
||||
Description
|
||||
-----------
|
||||
@ -11,7 +11,7 @@ This feature shares a physical interface for DPDK and SR-IOV usage.
|
||||
Prerequisites
|
||||
-------------
|
||||
|
||||
- Installed `Fuel 8.0 <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_
|
||||
- Installed `Fuel 9.* <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_
|
||||
- Installed Fuel Contrail Plugin :doc:`/install_guide`
|
||||
- Environment must be created with "KVM" for compute virtualization and "Contrail" for networking
|
||||
- Network card must support DPDK.
|
||||
@ -22,22 +22,25 @@ How to enable DPDK on VF
|
||||
------------------------
|
||||
|
||||
#. Enable DPDK feature :doc:`/dpdk`.
|
||||
#. Enable SRIOV feature :doc:`/enable_sriov`.
|
||||
#. Enable DPDK on VF in Fuel UI settings:
|
||||
|
||||
.. image:: images/enable_dpdk_on_vf.png
|
||||
|
||||
#. Assign ``Compute``, ``DPDK``, and ``SRIOV`` roles to the host where you want to enable DPDK on VF feature:
|
||||
#. Assign ``Compute``, ``DPDK``, and ``DPDK-on-VF`` roles to the host where you want to enable DPDK on VF feature:
|
||||
|
||||
.. image:: images/compute_dpdk_sriov_roles.png
|
||||
|
||||
#. Add ``intel_iommu=on iommu=pt`` to kernel parameters:
|
||||
|
||||
.. image:: images/kernel_params.png
|
||||
|
||||
#. Deploy environment
|
||||
|
||||
If DPDK on VF is enabled in plugin settings, it will be deployed on computes with ``DPDK``
|
||||
and ``SR-IOV`` roles.
|
||||
and ``DPDK-on-VF`` roles.
|
||||
During deploy following configurations will be made on compute nodes with DPDK and SR-IOV roles:
|
||||
|
||||
#. Virtual functions will be allocated on private interface.
|
||||
#. First VF (dpdk-vf0) will be used for DPDK-based vRouter.
|
||||
#. First VFwill be used for DPDK-based vRouter.
|
||||
#. Rest of the VFs will be added to ``pci_passthrough_whitelist`` setting in ``nova.conf``
|
||||
for SR-IOV usage.
|
||||
|
@ -42,32 +42,10 @@ run the following command on the boostraped host::
|
||||
Enable SR-IOV in Fuel
|
||||
---------------------
|
||||
|
||||
To enable SR-IOV in Fuel:
|
||||
To enable SR-IOV in Fuel go to node interface configuration and enable it as shown on picture
|
||||
|
||||
#. Enable SR-IOV in plugin settings and configure a unique physnet name.
|
||||
.. image:: images/sriov_interface.png
|
||||
|
||||
.. image:: images/enable_sriov_settings.png
|
||||
|
||||
.. raw:: latex
|
||||
|
||||
\pagebreak
|
||||
|
||||
2. Assign a ``SRIOV`` role to compute hosts.
|
||||
|
||||
.. image:: images/enable_sriov_role_node.png
|
||||
|
||||
.. note::
|
||||
|
||||
SR-IOV will be enabled on all SR-IOV capable interfaces, not assigned
|
||||
to the Fuel bridges - the networks in Fuel web UI.
|
||||
|
||||
.. raw:: latex
|
||||
|
||||
\pagebreak
|
||||
|
||||
3. You can modify the list of interfaces manually after deployment.
|
||||
|
||||
.. image:: images/sriov_interfaces.png
|
||||
|
||||
#. Deploy as in 5.3.10 :doc:`/install_guide`
|
||||
|
||||
|
@ -1,104 +0,0 @@
|
||||
adv_net_template:
|
||||
default:
|
||||
network_assignments:
|
||||
fuelweb_admin:
|
||||
ep: br-fw-admin
|
||||
private:
|
||||
ep: br-mesh
|
||||
public:
|
||||
ep: br-ex
|
||||
network_scheme:
|
||||
public:
|
||||
transformations:
|
||||
- action: add-br
|
||||
name: br-ex
|
||||
- action: add-br
|
||||
name: br-floating
|
||||
provider: ovs
|
||||
- action: add-patch
|
||||
bridges:
|
||||
- br-floating
|
||||
- br-ex
|
||||
provider: ovs
|
||||
mtu: 65000
|
||||
- action: add-port
|
||||
bridge: br-ex
|
||||
name: <% if2 %>
|
||||
endpoints:
|
||||
- br-ex
|
||||
roles:
|
||||
public/vip: br-ex
|
||||
neutron/floating: br-floating
|
||||
ceph/radosgw: br-ex
|
||||
ex: br-ex
|
||||
common:
|
||||
endpoints:
|
||||
- br-mesh
|
||||
- br-fw-admin
|
||||
roles:
|
||||
admin/pxe: br-fw-admin
|
||||
ceilometer/api: br-mesh
|
||||
ceph/public: br-mesh
|
||||
cinder/api: br-mesh
|
||||
fw-admin: br-fw-admin
|
||||
glance/api: br-mesh
|
||||
heat/api: br-mesh
|
||||
horizon: br-mesh
|
||||
keystone/api: br-mesh
|
||||
management: br-mesh
|
||||
mgmt/corosync: br-mesh
|
||||
mgmt/database: br-mesh
|
||||
mgmt/memcache: br-mesh
|
||||
mgmt/messaging: br-mesh
|
||||
mgmt/vip: br-mesh
|
||||
contrail/vip: br-mesh
|
||||
mongo/db: br-mesh
|
||||
murano/api: br-mesh
|
||||
neutron/api: br-mesh
|
||||
neutron/mesh: br-mesh
|
||||
nova/api: br-mesh
|
||||
nova/migration: br-mesh
|
||||
sahara/api: br-mesh
|
||||
swift/api: br-mesh
|
||||
neutron/private: br-mesh
|
||||
ceph/replication: br-mesh
|
||||
cinder/iscsi: br-mesh
|
||||
storage: br-mesh
|
||||
swift/replication: br-mesh
|
||||
swift/public: br-mesh
|
||||
transformations:
|
||||
- action: add-br
|
||||
name: br-fw-admin
|
||||
- action: add-port
|
||||
bridge: br-fw-admin
|
||||
name: <% if1 %>
|
||||
- action: add-br
|
||||
name: br-mesh
|
||||
- action: add-port
|
||||
bridge: br-mesh
|
||||
name: <% if3 %>
|
||||
- action: add-br
|
||||
name: br-aux
|
||||
nic_mapping:
|
||||
default:
|
||||
if1: enp0s3 # admin
|
||||
if2: enp0s4 # public
|
||||
if3: enp0s5 # management
|
||||
templates_for_node_role:
|
||||
cinder:
|
||||
- common
|
||||
compute:
|
||||
- common
|
||||
controller:
|
||||
- public
|
||||
- common
|
||||
ceph-osd:
|
||||
- common
|
||||
mongo:
|
||||
- common
|
||||
contrail-db:
|
||||
- common
|
||||
contrail-control:
|
||||
- common
|
||||
contrail-config:
|
||||
- common
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 41 KiB |
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 121 KiB |
BIN
doc/source/images/huge_pages.png
Normal file
After Width: | Height: | Size: 154 KiB |
BIN
doc/source/images/kernel_params.png
Normal file
After Width: | Height: | Size: 19 KiB |
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 107 KiB |
Before Width: | Height: | Size: 105 KiB After Width: | Height: | Size: 130 KiB |
BIN
doc/source/images/sriov_interface.png
Normal file
After Width: | Height: | Size: 70 KiB |
@ -16,11 +16,10 @@ Guide to the Contrail plugin version 5.0-5.0.0-1 for Fuel 9.0
|
||||
dpdk_on_vf
|
||||
enable_sriov
|
||||
contrail_tsn
|
||||
using_network_templates
|
||||
vmware
|
||||
upgrade
|
||||
verification
|
||||
restoring_failed_contrail_node
|
||||
contrail_ui_intro
|
||||
tuning
|
||||
vmware
|
||||
appendix
|
||||
|
@ -102,7 +102,13 @@ To configure the Contrail plugin, follow the steps below:
|
||||
|
||||
* At least 1 Compute
|
||||
|
||||
* At least 1 node with Contrail-Control, Contrail-Config, Contrail-Analytics and Contrail-DB roles selected
|
||||
* At least 1 Contrail-Controller
|
||||
|
||||
.. note::
|
||||
|
||||
Three or the greater odd number of nodes recommended for HA.
|
||||
|
||||
* At least 1 Contrail-Analytics + Contrail-Analytics-DB
|
||||
|
||||
.. note::
|
||||
|
||||
@ -110,19 +116,13 @@ To configure the Contrail plugin, follow the steps below:
|
||||
|
||||
* If you plan to use Heat with autoscaling, in addition to Ceilometer you need to add node with MongoDB role
|
||||
|
||||
You do not need to have these three roles on the same node.
|
||||
You can place them on different nodes if needed. For example, place Database and Analytics
|
||||
on dedicated nodes to improve performance.
|
||||
|
||||
.. image:: images/contrail-roles.png
|
||||
|
||||
|
||||
The figure below shows sample node configuration.
|
||||
|
||||
.. image:: images/node-roles.png
|
||||
|
||||
|
||||
#. The recommended size of partition for the Contrail database is 256 GB or more.
|
||||
#. The recommended size of partition for the Contrail-Analytics database is 256 GB or more.
|
||||
|
||||
#. Configure the network settings. See details at
|
||||
`Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_.
|
||||
|
@ -1,8 +1,8 @@
|
||||
Limitations
|
||||
===========
|
||||
|
||||
* Plugin does not support removing Contrail-DB nodes from a cluster. This can lead to data loss and must be
|
||||
a manual procedure.
|
||||
* Plugin does not support removing Contrail-Controller and Analytics-DB nodes from a cluster.
|
||||
This can lead to data loss and must be a manual procedure.
|
||||
Plugin supports adding new Contrail-DB nodes to the environment.
|
||||
|
||||
* The Fuel Networking option "Assign public network to all nodes" is not compatible with Contrail Plugin.
|
||||
|
@ -1,12 +1,16 @@
|
||||
New features in plugin version 4.0-4.0.1-1
|
||||
New features in plugin version 5.0-5.0.0-1
|
||||
==========================================
|
||||
|
||||
* Fuel 8.0 with OpenStack Liberty support
|
||||
* Fuel 9.0 with OpenStack Mitaka support
|
||||
|
||||
* Dedicated Analytics node role
|
||||
* Dedicated Analytics and Analytics DB node roles
|
||||
|
||||
* DPDK on VF (experimental)
|
||||
* Contrail-Config, Contrail-Control and Contrail-DB are merged into Contrail-Controller role
|
||||
|
||||
* TSN (experimental)
|
||||
* DPDK on VF, including bonded VFs
|
||||
|
||||
* Sahara and Murano compatibility (experimental)
|
||||
* Sahara and Murano compatibility
|
||||
|
||||
* vCenter as a secondary hypervisor support
|
||||
|
||||
* TSN in HA mode
|
||||
|
@ -4,15 +4,14 @@ Requirements
|
||||
The plugin has the following requirements for software and hardware:
|
||||
|
||||
+--------------------------------+-----------------------------------------------------------------+
|
||||
| Fuel version | 8.0 |
|
||||
| Fuel version | 9.* |
|
||||
+--------------------------------+-----------------------------------------------------------------+
|
||||
| Juniper Contrail version | 3.0.2 |
|
||||
| | testing was performed on 3.0.2.1-4 |
|
||||
| Juniper Contrail version | 3.1.0.0 |
|
||||
| | testing was performed on 3.1.0.0-25 |
|
||||
+--------------------------------+-----------------------------------------------------------------+
|
||||
| Hardware | * At least 1 additional server for Contrail controller |
|
||||
| | (contrail-control, contrail-config, contrail-analytics, |
|
||||
| | contrail-db roles). |
|
||||
| | Contrail-DB requires 320 Gb disk space. |
|
||||
| Hardware | * At least 2 additional servers: for Contrail controller |
|
||||
| | and for combined Analytics and Analytics-DB |
|
||||
| | Analytics-DB requires 320 Gb disk space. |
|
||||
| | |
|
||||
| | * Additional network interface on each |
|
||||
| | node except for MOS Controller. |
|
||||
|
@ -20,7 +20,7 @@ More information on running custom deployment graphs can be found in
|
||||
Prequisites
|
||||
-----------
|
||||
|
||||
This guide assumes that you have installed Fuel 9.0 with the Fuel Contrail plugin,
|
||||
This guide assumes that you have installed Fuel 9.1 with the Fuel Contrail plugin,
|
||||
and successfully deployed the environment according to :doc:`/install_guide`.
|
||||
|
||||
Package versions supported:
|
||||
@ -80,28 +80,32 @@ starts. The Neutron service will be restarted in case if contrail core plugin wi
|
||||
ssh <the Fuel Master node ip>
|
||||
cd /var/www/nailgun/plugins/contrail-5.0/
|
||||
|
||||
# Check ID of contrail plugin:
|
||||
#. Check ID of contrail plugin:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
fuel plugins
|
||||
|
||||
# Check ID of your env:
|
||||
#. Check ID of your env:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
fuel2 env list
|
||||
|
||||
# Upload upgrade graph:
|
||||
#. Upload upgrade graph:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
fuel2 graph upload --plugin <plugin-ID> --type contrail_upgrade_control --file upgrade_control.yaml
|
||||
|
||||
#Verify the graph has been uploaded:
|
||||
#. Verify the graph has been uploaded:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
fuel2 graph list --env <env-ID>
|
||||
|
||||
# Execute the custom graph to upgrade control plane:
|
||||
#. Execute the custom graph to upgrade control plane:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
fuel2 graph execute --env <env-ID> --type contrail_upgrade_control
|
||||
@ -128,28 +132,32 @@ during the vRouter upgrade, this can take up to 5 min.
|
||||
ssh <the Fuel Master node ip>
|
||||
cd /var/www/nailgun/plugins/contrail-5.0/
|
||||
|
||||
# Check ID of contrail plugin:
|
||||
#. Check ID of contrail plugin:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
fuel plugins
|
||||
|
||||
# Check ID of your env:
|
||||
#. Check ID of your env:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
fuel2 env list
|
||||
|
||||
# Upload upgrade graph:
|
||||
#. Upload upgrade graph:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
fuel2 graph upload --plugin <plugin-ID> --type contrail_upgrade_compute --file upgrade_compute.yaml
|
||||
|
||||
#Verify the graph has been uploaded:
|
||||
#. Verify the graph has been uploaded:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
fuel2 graph list --env <env-ID>
|
||||
|
||||
# Execute the custom graph to upgrade compute hosts:
|
||||
#. Execute the custom graph to upgrade compute hosts:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
fuel2 graph execute --env <env-ID> --type contrail_upgrade_compute
|
||||
|
@ -1,60 +0,0 @@
|
||||
Use network templates
|
||||
=====================
|
||||
|
||||
Starting from Fuel 7.0, you can reduce the number of logical networks
|
||||
using network templates.
|
||||
|
||||
.. seealso::
|
||||
|
||||
`Operations guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/cli/cli_network_template.html>`_
|
||||
|
||||
This document provides a sample configuration with a network template
|
||||
to get customers up and running quickly.
|
||||
|
||||
The provided template utilizes three networks: Admin (PXE), Public, and Private.
|
||||
|
||||
To use the network template:
|
||||
|
||||
#. Perform steps 5.3.1 - 5.3.7 from :doc:`/install_guide`
|
||||
|
||||
#. Configure interfaces as shown on figure:
|
||||
|
||||
.. image:: images/conf-interfaces2.png
|
||||
|
||||
.. raw:: latex
|
||||
|
||||
\pagebreak
|
||||
|
||||
3. Set a gateway for the private network:
|
||||
|
||||
#. Login with ssh to Fuel master node.
|
||||
#. List existing network-groups:
|
||||
::
|
||||
|
||||
fuel network-group --env 1
|
||||
|
||||
#. Remove and create again network-group ``private`` to set a gateway:
|
||||
::
|
||||
|
||||
fuel network-group --delete --network 5
|
||||
fuel network-group --create --name private \
|
||||
--cidr 10.109.3.0/24 --gateway 10.109.3.1 --nodegroup 1
|
||||
|
||||
#. Set the ``render_addr_mask`` parameter to ``internal`` for this network by typing:
|
||||
::
|
||||
|
||||
fuel network-group --set --network 6 \
|
||||
--meta '{"name": "private", "notation": "cidr",\
|
||||
"render_type": null, "map_priority": 2, \
|
||||
"configurable": true, "use_gateway": true,\
|
||||
"render_addr_mask": "internal", "vlan_start": null, \
|
||||
"cidr": "10.109.3.0/24"}'
|
||||
|
||||
|
||||
#. Save sample :download:`network template<examples/network_template_1.yaml>`
|
||||
#. Upload the network template by typing:
|
||||
::
|
||||
|
||||
fuel --env 1 network-template --upload --dir /root/
|
||||
|
||||
#. Start deployment by pressing :guilabel:`Deploy changes` button.
|