Ways to Contribute

Join the Mailing List

Please participate in the discussion about nf.io by joining our mailing list. To sign up, please go to https://groups.google.com/forum/#!forum/nfio

Bug Reports & Feature Requests

Please post any bugs reports or feature requests by creating an issue on Github.

Include New VNFs

• (Assume nf.io is mounted at NFIO_MOUNT and nf.io source is located at NFIO_SRC.) To include a new VNF create a python module with the same name as the type of VNF and put the python file inside $NFIO_SRC/src/middleboxes directory. For example, if you want to integrate a middlebox of type "my_new_middlebox", then create a python file named my_new_middlebox.py and put it inside $NFIO_SRC/src/middleboxes directory. my_new_middlebox.py should implement the following methods:
  • _mkdir
  • _getattr
  • _read
  • _write
• For details on the parameter list and semantics of these methods see the middleboxes package documentation at $NFIO_SRC/src/middleboxes/__init__.py.
• Once the module is placed inside $NFIO_SRC/src/middleboxes directory, create a directory corresponding to the new middlebox type under $NFIO_MOUNT/nf-types. This newly created directory should have the same name as the added python file, i.e., my_new_middlebox in this case. Once the directory is created the new middlebox is integrated into nf.io. Now instances of this new middlebox by can be created by creating instance directories under $NFIO_MOUNT/my_new_middlebox.