summaryrefslogtreecommitdiff
path: root/README.md
blob: 92a6ef37b8f0c2062b7e37b438ffd89032c995cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
VXLAN plugin for Fuel
===================

VXLAN plugin
---------------

Overview
--------
By default the openstack environment is configured with gre or vlan segmentation type. This plugin allows to create vxlan private network.

This repo contains all necessary files to build vxlan Fuel plugin.

Requirements
------------

| Requirement                      | Version/Comment                                         |
|----------------------------------|---------------------------------------------------------|
| Mirantis Openstack compatibility | 6.1                                                   |
|----------------------------------|---------------------------------------------------------|


Recommendations
---------------

None.

Limitations
-----------

None.

Installation Guide
==================

Vxlan plugin installation
----------------------------

1. Clone the fuel-plugin repo from: https://github.com/stackforge/fuel-plugin-vxlan.git

    ``git clone``

2. Install the Fuel Plugin Builder:

    ``pip install fuel-plugin-builder``

3. Build vxlan Fuel plugin:

   ``fpb --build fuel-plugin-vxlan/``

4. The vxlan-<x.x.x>.rpm file will be created in the plugin folder (fuel-plugin-vxlan)

5. Move this file to the Fuel Master node with secure copy (scp):

   ``scp vxlan-<x.x.x>.rpm root@:<the_Fuel_Master_node_IP address>:/tmp``
   ``cd /tmp``

6. Install the vxlan plugin:

   ``fuel plugins --install vxlan-<x.x.x>.rpm``

7.  Verify that the plugin is installed correctly:
   ``fuel plugins --list``

8. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI.

User Guide
==========

https plugin configuration
-----------------------------

1. Create a new environment with the Fuel UI wizard with gre segmentation type selected

2. Add a node with the "Compute" role.

3. Click on the settings tab of the Fuel web UI

4. Scroll down the page, select the "vxlan plugin" checkbox



Deployment details
------------------

Configure neutron/ml2plugin to use vxlan as default segmentation type 
Configureboth controller and compute neutron/ml2plugin  to create vxlan tunneling
Restart neutron services


Known issues
------------

None.

Release Notes
-------------

**1.0.0**

* Initial release of the plugin

**2.0.0**

* migrate plugins from 1.0.0 to 2.0.0 package version