summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 18 insertions, 6 deletions
diff --git a/README.md b/README.md
index 96a10b9..83e6864 100644
--- a/README.md
+++ b/README.md
@@ -28,24 +28,32 @@ Details of the changes leading up to this version of Sweetcomb can be found unde
Make sure you have added FD.io repository using https://packagecloud.io/fdio/release/
installation script.
-You should have a sight on the release package, the package name may be defferent in
-rpm and deb on defferent version
-(such vpp-plugins.deb in 19.01 and vpp-plugin-core.deb and vpp-plugin-dpdk.deb in 19.04)
+You should have a sight on the release package, the package name may be different depending on the distribution.
+(ex: vpp-plugins.deb for VPP 19.01 and vpp-plugin-core.deb and vpp-plugin-dpdk.deb in 19.04)
Firstly, please follow below steps to install dependencies and build code:
+```
cd $/sweetcomb/
make install-dep
make install-dep-extra
make install-vpp
make build-scvpp
make build-plugins
+```
+
+Next, install YANG models in sysrepo:
+```
+ make install-models
+```
Then, please start each daemon one by one:
+```
start vpp (for example on Ubuntu: systemctl start vpp)
sysrepod
sysrepo-plugind
netopeer2-server
netopeer2-cli
+```
Now you can utilize Sweetcomb.
@@ -54,13 +62,16 @@ For example, if you want to configure ipv4 address on HW interface TenGigabitEth
You can follow below steps to verify if Sweetcomb is working well.
Firstly, set interface up:
- vppctl set interface state TenGigabitEthernet5/0/0 up
+`vppctl set interface state TenGigabitEthernet5/0/0 up`
Then, starting netopeer2-cli on any host:
netopeer2-cli
+```
> connect --host <ip address running Sweetcomb> --login <user>
> edit-config --target running --config
-## Press Enter and then past below XML example into the editor and quit
+```
+
+```
<interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces">
<interface>
<name>TenGigabitEthernet5/0/0</name>
@@ -77,8 +88,9 @@ Then, starting netopeer2-cli on any host:
<enabled>true</enabled>
</interface>
</interfaces>
+```
Finally, check the configuration result.
- vppctl show interface address
+ `vppctl show interface address`
If you configure above successfully, you will get ip address set up on interface TenGigabitEthernet5/0/0.