Browse Source

Update readme

Change-Id: Id4e46a951e95a7df6a4dd44a1fd168d82acb0d20
Bartosz Kupidura 2 years ago
parent
commit
7a3e46edea
1 changed files with 21 additions and 8 deletions
  1. 21
    8
      README.md

+ 21
- 8
README.md View File

@@ -1,5 +1,5 @@
1 1
 Networking SFC plugin for Fuel
2
-=======================
2
+==============================
3 3
 
4 4
 Networking SFC
5 5
 --------------
@@ -19,30 +19,37 @@ Requirements
19 19
 |:---------------------------------|:--------|
20 20
 | Mirantis OpenStack compatibility | 9.0     |
21 21
 
22
-It is required to install this on vxlans enabled environment. Will not work otherwise.
22
+It is required to install this on vxlans/gre enabled environment. Will not work otherwise.
23
+Neutron L2 population setting should be also enabled.
24
+
23 25
 
24 26
 Installation Guide
25 27
 ==================
26 28
 
27 29
 Networking SFC plugin installation
28
----------------------------
30
+----------------------------------
29 31
 
30 32
 To install Networking SFC plugin, follow these steps:
31 33
 
32
-1. Build a plugin `fpb --build dir`
34
+#. Install all needed dependencies
35
+
36
+        # apt-get install git ruby-dev
37
+        # gem install fpm
38
+
39
+#. Build a plugin `fpb --build dir`
33 40
 
34
-2. Copy the plugin on already installed Fuel Master node; ssh can be used for
41
+#. Copy the plugin on already installed Fuel Master node; ssh can be used for
35 42
     that. If you do not have the Fuel Master node yet, see
36 43
     [Quick Start Guide](https://software.mirantis.com/quick-start/) :
37 44
 
38 45
         # scp networking-sfc-<version>.noarch.rpm root@<Fuel_Master_ip>:/tmp
39 46
 
40
-3. Install the plugin:
47
+#. Install the plugin:
41 48
 
42 49
         # cd /tmp
43 50
         # fuel plugins --install networking-sfc-<version>.noarch.rpm
44 51
 
45
-4. Check if the plugin was installed successfully:
52
+#. Check if the plugin was installed successfully:
46 53
 
47 54
         # [root@nailgun ~]# fuel plugins
48 55
         id | name           | version | package_version | releases
@@ -50,13 +57,19 @@ To install Networking SFC plugin, follow these steps:
50 57
         1  | networking-sfc | 1.0.0   | 4.0.0           | ubuntu (mitaka-9.0)
51 58
 
52 59
 Networking SFC plugin configuration
53
-----------------------------
60
+-----------------------------------
54 61
 
55 62
 1. Create an environment.
56 63
 2. Enable L2 Population in network tab.
57 64
 3. Enable the plugin on the Settings tab of the Fuel web UI.
58 65
 4. Deploy the environment.
59 66
 
67
+Known issues
68
+------------
69
+
70
+#. Fuel plugin should be build on Ubuntu system (https://bugs.launchpad.net/networking-sfc/+bug/1593693).
71
+#. Networking-SFC is very dynamic project, because of that we stick to last known working commit.
72
+
60 73
 Contributors
61 74
 ------------
62 75
 

Loading…
Cancel
Save