diff --git a/doc/source/library.rst b/doc/source/library.rst index 6b084c33..28d3e314 100644 --- a/doc/source/library.rst +++ b/doc/source/library.rst @@ -8,3 +8,4 @@ Ryu provides some useful library for your network applications. :maxdepth: 1 library_packet.rst + library_of_config.rst diff --git a/doc/source/library_of_config.rst b/doc/source/library_of_config.rst new file mode 100644 index 00000000..d2a953d4 --- /dev/null +++ b/doc/source/library_of_config.rst @@ -0,0 +1,24 @@ +***************** +OF-Config support +***************** + +Ryu has a library for OF-Config support. + +XML schema files for NETCONFIG and OFConfig +=========================================== +XML schema files for NETCONF and OFConfig are stolen from LINC whose licence +is Apache 2.0. +It supports only part of OFConfig so that its schema files are (intentionally) +limited such that operation attributes are allowed only in several limited +places. +Once our library is tested with other OFConfig switches, the schema files +should be updated to allow operation attribute in more places. + +References +========== +* `NETCONF ietf `_, +* `NETCONF ietf wiki `_, +* `OF-Config spec `_, +* `ncclient `_, +* `ncclient repo `_, +* `LINC git repo `_ diff --git a/ryu/lib/of_config/README.rst b/ryu/lib/of_config/README.rst deleted file mode 100644 index 68734f76..00000000 --- a/ryu/lib/of_config/README.rst +++ /dev/null @@ -1,7 +0,0 @@ -XML schema for OFConfig -======================= -Those files of XML schema for OFConfig are stolen from LINC. -It supports only part of it so that its schema files are limited as operation -attributes are allowed only in several places. -Once tested with other OFConfig switches , the schema files should be updasted -to allow more operation attribute.