Provides RST instead of GitHub markdown
If GitHub markdown is used, then it's impossible to build pdf version of the documentation. Change-Id: Ic74cba85df0dca39c1e026bb968b9cb340ffa1a4
This commit is contained in:
Irina Povolotskaya
parent
fba8e08ffd
commit
36f81fc6ab
|
|
@ -10,7 +10,7 @@ MidoNet version that will be deployed is v2015.06_ and this plugin currently is
|
|||
only compatible with version 6.1 of Mirantis OpenStack Fuel.
|
||||
|
||||
There are no prerequisites to use the MidoNet plugin: MidoNet is Open Source,
|
||||
and the plugins sets the repositories from where download and install MidoNet
|
||||
and the plugin sets the repositories from where download and install MidoNet
|
||||
packages.
|
||||
|
||||
|
||||
|
|
@ -27,12 +27,12 @@ MidoNet plugin for Fuel 2.0.0
|
|||
Limitations
|
||||
-----------
|
||||
|
||||
The plugin is **only** compatible with OpenStack environments deployed with
|
||||
**Neutron + GRE** as network configuration in the environment configuration
|
||||
options. However, VXLAN can be configured on the plugin settings after
|
||||
the environment creation.
|
||||
* The plugin is **only** compatible with OpenStack environments deployed with
|
||||
**Neutron + GRE** as network configuration in the environment configuration
|
||||
options. However, VXLAN can be configured on the plugin settings after
|
||||
the environment creation.
|
||||
|
||||
The plugin currently only work with CentOS 6.5 environments. We are working on
|
||||
make it work for Ubuntu environments
|
||||
* The plugin currently only works with CentOS 6.5 environments. In near future, it
|
||||
should work for Ubuntu environments as well.
|
||||
|
||||
.. _v2015.06: https://github.com/midonet/midonet/tree/stable/v2015.06.2
|
||||
|
|
|
|||
|
|
@ -24,7 +24,8 @@ Fuel 6.1 reference architecture has a schema with the `networks that deploys
|
|||
|
||||
ML2 networks:
|
||||
|
||||
.. image:: ../images/fuelml2gre.png
|
||||
.. image:: images/fuelml2gre.png
|
||||
:width: 100%
|
||||
|
||||
In this schema, red network represents the Public + Floating IP range. That
|
||||
means API access to services and Virtual Machines' Floating IPs share the same
|
||||
|
|
@ -59,7 +60,8 @@ environment settings get overridden.
|
|||
|
||||
MidoNet deployment schema:
|
||||
|
||||
.. image:: ../images/midonet_fuel.png
|
||||
.. image:: images/midonet_fuel.png
|
||||
:width: 100%
|
||||
|
||||
On this schema:
|
||||
|
||||
|
|
@ -100,7 +102,8 @@ Select Environment
|
|||
|
||||
When creating the environment, choose Neutron with GRE on the Network tab.
|
||||
|
||||
.. image:: ../images/gre_environment.png
|
||||
.. image:: images/gre_environment.png
|
||||
:width: 100%
|
||||
|
||||
MidoNet plugin does not interact with the rest of the options, so choose
|
||||
whatever your deployment demands on them.
|
||||
|
|
@ -113,7 +116,8 @@ Configure MidoNet Plugin
|
|||
Configuring the MidoNet plugin for Fuel, you will override most of the options
|
||||
of the *Public Network* section of the *Settings* tab of the environment:
|
||||
|
||||
.. image:: ../images/overridden_options.png
|
||||
.. image:: images/overridden_options.png
|
||||
:width: 100%
|
||||
|
||||
Fuel will still reserve IP addresses of the *IP range* (first row) to assign
|
||||
API-accessible IPs to the OpenStack services, but the rest will be overridden by
|
||||
|
|
@ -124,11 +128,13 @@ First, you need to activate the option **Assign public networks to all nodes**.
|
|||
By default, Fuel only gives public access to Controllers. We need to enable
|
||||
this option in order to have external connectivity to Gateway Nodes.
|
||||
|
||||
.. image:: ../images/public_to_all.png
|
||||
.. image:: images/public_to_all.png
|
||||
:width: 100%
|
||||
|
||||
Then, activate the plugin and fill the options:
|
||||
|
||||
.. image:: ../images/plugin_config.png
|
||||
.. image:: images/plugin_config.png
|
||||
:width: 100%
|
||||
|
||||
Let's explain them:
|
||||
|
||||
|
|
@ -163,11 +169,11 @@ Assign Roles to Nodes
|
|||
Go to the *Nodes* tab and you will see the **Network State DataBase** and
|
||||
**MidoNet HA Gateway** roles available to be assigned to roles.
|
||||
|
||||
.. image:: ../images/nodes_to_roles.png
|
||||
|
||||
.. image:: images/nodes_to_roles.png
|
||||
:width: 100%
|
||||
|
||||
Just follow one rule:
|
||||
|
||||
- **DO NOT** assign the role **Gateway** and the role **Controller** altogether.
|
||||
|
||||
**NSDB** role can be combined with any other role.
|
||||
**NSDB** role can be combined with any other role.
|
||||
|
|
@ -5,7 +5,7 @@ Enable Experimental Features
|
|||
----------------------------
|
||||
|
||||
To be able to install **MidoNet**, you should enable `Experimental Features`_.
|
||||
To do so, Manually modify the ``/etc/fuel/version.yaml`` file in *Fuel Master*
|
||||
To do so, manually modify the ``/etc/fuel/version.yaml`` file in *Fuel Master*
|
||||
host to add ``experimental`` to the ``feature_groups`` list in the ``VERSION``
|
||||
section, just below ``mirantis`` item:
|
||||
|
||||
|
|
@ -39,12 +39,14 @@ To install the MidoNet Fuel plugin:
|
|||
|
||||
[root@home ~]# scp midonet-1.0-2.0.0-1.noarch.rpm root@fuel-master:/tmp
|
||||
|
||||
- Log into Fuel master node and install the plugin using the Fuel CLI:
|
||||
- Log into Fuel Master node and install the plugin using the
|
||||
`Fuel CLI <https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#using-fuel-cli>`_:
|
||||
|
||||
::
|
||||
|
||||
[root@fuel-master ~]# fuel plugins --install midonet-1.0-2.0.0-1.noarch.rpm
|
||||
|
||||
- Verify the plugin is installed correctly:
|
||||
- Verify that the plugin is installed correctly:
|
||||
::
|
||||
|
||||
[root@fuel-master ~]# fuel plugins
|
||||
|
|
@ -58,7 +60,7 @@ Create the MidoNet roles
|
|||
|
||||
MidoNet needs two roles besides the ones provided with Fuel:
|
||||
|
||||
- The **NSDB** role, which will install the Network State DataBase services
|
||||
- the **NSDB** role, which will install the Network State DataBase services
|
||||
(ZooKeeper and Cassandra).
|
||||
|
||||
- the **Gateway** role, that will provide the HA Gateway machine for inbound and
|
||||
|
|
@ -82,7 +84,8 @@ Create a YAML file with the **NSDB** role definition, like this:
|
|||
id: os
|
||||
|
||||
Name it, for instance, ``nsdb.yaml``. Push the role for both environments
|
||||
(``Ubuntu 2014.2.2-6.1`` and ``Centos 2014.2.2-6.1``) using the Fuel CLI[4]:
|
||||
(``Ubuntu 2014.2.2-6.1`` and ``Centos 2014.2.2-6.1``) using the
|
||||
`Fuel CLI <https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#using-fuel-cli>`_:
|
||||
|
||||
::
|
||||
|
||||
|
|
@ -107,7 +110,8 @@ Create the role for **MidoNet Gateway** by creating a file called
|
|||
id: os
|
||||
|
||||
And create the role for both environments (`Ubuntu 2014.2.2-6.1` and `Centos
|
||||
2014.2.2-6.1`) using the Fuel CLI[4]:
|
||||
2014.2.2-6.1`) using the
|
||||
`Fuel CLI <https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#using-fuel-cli>`_
|
||||
|
||||
::
|
||||
|
||||
|
|
@ -168,7 +172,7 @@ Download the deployment tasks for the release 1:
|
|||
|
||||
A file ``./release_1/deployment_tasks.yaml`` will be downloaded
|
||||
|
||||
Without moving from your current directory, Append the
|
||||
Without moving from your current directory, append the
|
||||
``/tmp/midonet_groups.yaml`` file into the ``deployment_tasks.yaml`` one:
|
||||
|
||||
::
|
||||
|
|
|
|||
|
|
@ -7,9 +7,9 @@ MidoNet plugin for Fuel.
|
|||
Sections
|
||||
--------
|
||||
|
||||
- `Plugin Description <./content/description.rst>`_
|
||||
- `Terms <./content/terms.rst>`_
|
||||
- `Installation Guide <./content/installation.rst>`_
|
||||
- `User Guide <./content/guide.rst>`_
|
||||
- `Licenses <./content/licenses.rst>`_
|
||||
- `Appendix <./content/appendix.rst>`_
|
||||
.. include:: content/description.rst
|
||||
.. include:: content/terms.rst
|
||||
.. include:: content/installation.rst
|
||||
.. include:: content/guide.rst
|
||||
.. include:: content/licenses.rst
|
||||
.. include:: content/appendix.rst
|
||||
|
|
|
|||
Loading…
Reference in New Issue