summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2018-10-16 00:54:55 +0000
committerGerrit Code Review <review@openstack.org>2018-10-16 00:54:55 +0000
commitc9cca1170b1d6b8e20698482e1928c8f0f2e0eef (patch)
treeb193372d9935b6c89458bcfac47c97cd0f8a4691
parent04175b9e4aef4618b0da0c4018e91d355ae180d6 (diff)
parentc64394a37d022ef16646b39ebcae3adec7763d6e (diff)
Merge "Update documentation"
-rw-r--r--README.rst12
-rw-r--r--devstack/README.rst40
-rw-r--r--doc/source/index.rst1
-rw-r--r--doc/source/installation/playbooks.rst1
-rw-r--r--doc/source/troubleshooting.rst12
-rw-r--r--doc/source/usage.rst31
6 files changed, 69 insertions, 28 deletions
diff --git a/README.rst b/README.rst
index 9e8c0d9..00b6073 100644
--- a/README.rst
+++ b/README.rst
@@ -2,18 +2,12 @@
2networking-opencontrail 2networking-opencontrail
3=============================== 3===============================
4 4
5Networking drivers and service plugins to integrate OpenContrail with Neutron 5Networking drivers and service plugins to integrate TungstenFabric with Neutron
6 6
7Please fill here a long description which must be at least 3 lines wrapped on 7The plugin integrates Tunsten Fabric backend with OpenStack Neutron.
880 cols, so that distribution package maintainers can use it in their packages. 8It communicates with Neutron over ML2 Mechanism Driver API.
9Note that this is a hard requirement.
10 9
11* Free software: Apache license 10* Free software: Apache license
12* Documentation: http://docs.openstack.org/developer/networking-opencontrail 11* Documentation: http://docs.openstack.org/developer/networking-opencontrail
13* Source: http://git.openstack.org/cgit/openstack/networking-opencontrail 12* Source: http://git.openstack.org/cgit/openstack/networking-opencontrail
14* Bugs: https://launchpad.net/networking-opencontrail 13* Bugs: https://launchpad.net/networking-opencontrail
15
16Features
17--------
18
19* TODO
diff --git a/devstack/README.rst b/devstack/README.rst
index 2456994..8d12ccb 100644
--- a/devstack/README.rst
+++ b/devstack/README.rst
@@ -2,29 +2,43 @@
2 Enabling in Devstack 2 Enabling in Devstack
3====================== 3======================
4 4
51. Download DevStack:: 5#. Download Devstack::
6 6
7 git clone https://git.openstack.org/openstack-dev/devstack 7 git clone https://git.openstack.org/openstack-dev/devstack
8 cd devstack 8 cd devstack
9 9
102. Copy the sample local.conf, if you already do not have local.conf:: 10#. Copy the sample local.conf, if you already do not have local.conf::
11 11
12 cp samples/local.conf . 12 cp samples/local.conf .
13 13
143. Add this repo as an external repository:: 14#. In the local.conf add several lines as follows::
15 15
16 > cat local.conf 16 [[local|localrc]]
17 [[local|localrc]] 17 # (skipping already present lines...)
18 enable_plugin networking-opencontrail http://git.openstack.org/openstack/networking-opencontrail
19 18
204. Specify the Contrail API Server IP address and the port number:: 19 # Enable ML2 plugin
20 enable_plugin networking-opencontrail https://git.openstack.org/openstack/networking-opencontrail
21 Q_PLUGIN=ml2
22 ML2_L3_PLUGIN=opencontrail-router
23 NEUTRON_CREATE_INITIAL_NETWORKS=False
24 Q_USE_SECGROUP=True
25
26 # Specify the Contrail API Server IP address and the port number
27 OPENCONTRAIL_APISERVER_IP=192.168.0.16
28 OPENCONTRAIL_APISERVER_PORT=8082
29
30 # Configure ML2 plugin
31 PHYSICAL_NETWORK=public
32 TENANT_VLAN_RANGE=1:4094
33 [[post-config|$NEUTRON_CORE_PLUGIN_CONF]]
34 [ml2]
35 type_drivers = local,vlan
36 tenant_network_types = local,vlan
37 mechanism_drivers = opencontrail
38 extension_drivers = port_security
21 39
22 > cat local.conf
23 [[local|localrc]]
24 OPENCONTRAIL_APISERVER_IP=<ip address>
25 OPENCONTRAIL_APISERVER_PORT=<port-number>
26 40
275. Optionally, if you need to use secure SSL connection, specify additional 41#. Optionally, if you need to use secure SSL connection, specify additional
28 configuration variables as below:: 42 configuration variables as below::
29 43
30 > cat local.conf 44 > cat local.conf
@@ -35,4 +49,4 @@
35 OPENCONTRAIL_KEY_FILE=<Key file> 49 OPENCONTRAIL_KEY_FILE=<Key file>
36 OPENCONTRAIL_CA_FILE=<ca file> 50 OPENCONTRAIL_CA_FILE=<ca file>
37 51
386. run ``stack.sh`` 52#. run ``stack.sh``
diff --git a/doc/source/index.rst b/doc/source/index.rst
index efb46af..89164d8 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -18,6 +18,7 @@ Contents
18 installation/playbooks 18 installation/playbooks
19 devstack 19 devstack
20 usage 20 usage
21 troubleshooting
21 contributing 22 contributing
22 23
23Indices and tables 24Indices and tables
diff --git a/doc/source/installation/playbooks.rst b/doc/source/installation/playbooks.rst
index bf964fe..bce0549 100644
--- a/doc/source/installation/playbooks.rst
+++ b/doc/source/installation/playbooks.rst
@@ -164,6 +164,7 @@ Created VM could be accessed by VNC (through horizon):
1641. Go to horizon's list of VMs http://10.100.0.3/dashboard/project/instances/ 1641. Go to horizon's list of VMs http://10.100.0.3/dashboard/project/instances/
165 165
1662. Enter into the VM's console. 1662. Enter into the VM's console.
167
167 - If the console does not response, click the link "Click here to show only console". 168 - If the console does not response, click the link "Click here to show only console".
168 - If you see black console, press enter to attach. 169 - If you see black console, press enter to attach.
169 170
diff --git a/doc/source/troubleshooting.rst b/doc/source/troubleshooting.rst
new file mode 100644
index 0000000..464f13d
--- /dev/null
+++ b/doc/source/troubleshooting.rst
@@ -0,0 +1,12 @@
1===============
2Troubleshooting
3===============
4
5
6#. ``BadRequest: Bad virtual_network request: physical network must be configured.``
7
8 Please ensure that you create local or vlan network. File /etc/neutron/plugins/ml2/ml2_conf.ini should contain similar line (for full example of ml2 configuration see :doc:`devstack`)::
9
10 [ml2]
11 tenant_network_types = local,vlan
12
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
index ec445ba..2fac5ca 100644
--- a/doc/source/usage.rst
+++ b/doc/source/usage.rst
@@ -21,19 +21,38 @@ Installing networking-opencontrail as a DevStack plugin (see
21Manual configuration 21Manual configuration
22-------------------- 22--------------------
23 23
24#. Adjust ``/etc/neutron/plugins/ml2/ml2_conf_opencontrail.ini`` to meet 24#. Install plugin::
25 your needs.
26#. Edit ``/etc/neutron/plugins/ml2/ml2_conf.ini`` file:
27 25
28 * Add ``opencontrail`` to ``mechanism_drivers`` list in ``ml2`` section 26 pip install networking-opencontrail
29 * Add ``opencontrail-router`` to ``service_plugins`` list in ``DEFAULT`` section
30 27
31 After editing file should look similarly to this:: 28#. Adjust ``/etc/neutron/plugins/ml2/ml2_conf_opencontrail.ini``
29 to meet the example::
30
31 [APISERVER]
32 api_server_port = 8082
33 api_server_ip = 192.168.0.2
34
35#. Adjust ``/etc/neutron/neutron.conf`` to meet the example.
36
37 * Ensure you have ``ml2`` core plugin enabled
38 * Add ``opencontrail-router`` to ``service_plugins`` list.
39
40 Example::
32 41
33 [DEFAULT] 42 [DEFAULT]
43 core_plugin = ml2
34 service_plugins = opencontrail-router 44 service_plugins = opencontrail-router
35 45
46#. Edit ``/etc/neutron/plugins/ml2/ml2_conf.ini`` file:
47
48 * Add ``opencontrail`` to ``mechanism_drivers`` list in ``ml2`` section.
49
50 After editing file should look similarly to this::
51
36 [ml2] 52 [ml2]
53 type_drivers = local,vlan
54 tenant_network_types = local,vlan
55 extension_drivers = port_security
37 mechanism_drivers = opencontrail 56 mechanism_drivers = opencontrail
38 57
39#. Run again Neutron service. Make sure you include all config files: :: 58#. Run again Neutron service. Make sure you include all config files: ::