1054851e161528fd4270d6ed00488d2ff852295c
[netconf.git] / README.rst
1 ============================================
2 OpenDaylight NETCONF/RESTCONF implementation
3 ============================================
4
5 This project hosts implementations of protocols defined by the
6 `IETF NETCONF Working Group <https://datatracker.ietf.org/wg/netconf/about/>`__
7 In particular it implements:
8 * `Network Configuration Protocol (NETCONF) <https://www.rfc-editor.org/rfc/rfc6241>`__
9 * `RESTCONF Protocol <https://www.rfc-editor.org/rfc/rfc8040>`__
10
11 Your immediate interests may be:
12 * Documentation is in :doc:`docs <https://docs.opendaylight.org/projects/netconf/en/latest/index.html>`
13 * Ready-to-applications are in :doc:`apps <apps/README.rst>`
14
15 Other that that, you may delve into gory details:
16 * basic project infrastructure, including :doc:`the BOM <artifacts/README.rst>`,
17   :doc:`Karaf features <features/README.rst>`, :doc:`Dynamic Karaf distribution <karaf/README.rst>`,
18   :doc:`Static Karaf distribution <karaf-static/README.rst>` and the :doc:`Common Maven Parent <parent/README.rst>`
19 * :doc:`YANG models <models/README.rst>` relating to this project
20 * :doc:`Transport layer <transport/README.rst>` implementation
21 * :doc:`Low-level <protocol/README.rst>` protocol implementations
22 * :doc:`High-level <plugins/README.rst>` protocol integrations
23 * :doc:`NETCONF Key store <keystore/README.rst>` implementation
24 * :doc:`NETCONF Trust store <truststore/READ.rst>` implementation
25 * :doc:`applications <appls/README.rst>` for both end users and integrators