summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorYohanPipereau <ypiperea@cisco.com>2019-03-06 14:01:58 +0100
committerYohanPipereau <ypiperea@cisco.com>2019-03-29 14:39:36 +0100
commita760dfb253161911fc3aa3c8b879c461d53ade6e (patch)
tree0e79953f4ed5615879a58f49a74df3f9c6739a42 /README.md
parent2b9b6b9b130b75799a40989c0ebe5040fa3e45fb (diff)
Sweetcomb global cleanup
-Merge IETF and Openconfig to use SCVPP 2 -Move L2 bridge from sc_vpp_interface to sc_vpp_v3po -Implement tav2 dump -Make openconfig-interfaces functions static -Try one more dispatch after failure in VAPI_CALL -Add error return code for scvpp -Remove unused length maccros -Return appropriate error code for interface dump when interface not found -Improve scvpp test suite -Change get_interface_id prototype -Use interface_dump_iface in openconfig_interface. -No more vapi types in openconfig_interfaces.c -Move openconfig_local_routing VAPI operations to sc_vpp_ip -Implement a multiple dump with a stack data structure -Comment out state_cb code from openconfig_local_routing to use new functions later. -Rename YANG model to their fully qualified name : <module>@<revision> -Remove headers almost empty and put registration declaration in sc_model.h -Shorten vapi context global variable name -Reorganize scvpp unit test suite -Add instructions to Makefile to install/uninstall YANG models in sysrepo. -Add this new instructions to README.md. -Reimplement interface_dump_all -Use a common message at INFO Log Level to know when sysrepo callbacks are triggered -Remove old structure to perform dump of all interfaces -Reimplement get_interface_name and add scvpp test for it -Clean sys_util -Use UNUSED maccro everywhere to have lighter prototypes -Have ietf-interfaces:interfaces-state work with new dump function -Add setup and teardown for NAT tests -Remove unused tapv2 dump -Remove useless sysrepo module callback -Remove xpath_find_first_key usage in openconfig-interfaces -Remove xpath_find_first_key in oc_local_routing and in the rest of sweetcomb -Reorganize scvpp include dir and fix scvpp_test new warnings -Fix scvpp tests for ip routes -Factorize scvpp nat and test return code of its function -Correct test_dump_if_all if there is an existing hardware interface -Implement a per-prefix dump in scvpp -free changes iterator in ietf-interfaces -Add new XPATH in oc local-routing -Introduce helper methods for sysrepo config callbacks -Factorize config callback -Refactor the openconfig-local-routing config callback -Use common foreach_change to iterate over changes in all models -Create a sample directory gathering example of configurations supposed to work with sweetcomb -Fix state callback of oc-local-routing -Add new sample for get operation on next-hop -foreach_elt maccro condition forgets to read one element Change-Id: I8e87fce577a00337977588f057a6e095a20f457c Signed-off-by: YohanPipereau <ypiperea@cisco.com>
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.