diff --git a/applications/rtdt-manager/README.md b/applications/rtdt-manager/README.md index d3dcd16de80959fcc72e8d30df7ee76fe5553df7..9977a9b244aec65a022a9656e6f851d70d5f7e5c 100644 --- a/applications/rtdt-manager/README.md +++ b/applications/rtdt-manager/README.md @@ -50,16 +50,16 @@ instances of RabbitMQ, MongoDB, etc. The rtdt-manager subscribes to specific events in the physical network and a callback is triggered when these events occur. In this callback, the YANG path of the data that experienced a change as well as the new value can be retrieved and are applied to the NDT. -Changes can be applied to the physical network using `gosdnc prompt` and then typing the following (with an example path for MTU): +There are two modes to doing this: One is the limited mode where each path should be individually supported in the code. Right now, this includes `/system/config/hostname`, `/interfaces/interface[name=<name>]/config/mtu`, +and `/interfaces/interface[name=<name>]/config/enabled`. This mode is the default. The other mode is 'experimental' (or spicy) mode, where each event is synchronized. This can cause breakage, however and should mostly be used for testing. +To use this mode, pass `--experimental` to `rtdt-manager`. + +Changes can be applied to the physical network to test synchronization using `gosdnc prompt` and then typing the following (with an example path for MTU): ``` > login --controller 172.100.0.5:55055 --p TestPassword --u admin > networkElement path set <Choose a Target here> /interafces/interface[name=eth1]/config/mtu 2100 --force-push ``` -Right now there are some bugs in the event system/controller. Changing the hostname works reliably (`/system/config/hostname`), -the interfaces handler in the gNMI-target often triggers many unwanted events, so it's dangerous to subscribe to `interfaces/` -on its own. - ### Additional Changes to Code The code expects there to be a local Docker image for gnmi-target called `gnmi-target-local`. For this, you can clone the gnmi-target repo (see Section [#Building](#building)) and checkout the `interface-enabled-test`. The Makefile in this branch was modified to build this image.