X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide%2Fopenflow-plugin-project-developer-guide.rst;h=24a4870d142b4bf9d529105a7263c32133c1b44d;hb=6eed0c679576fa908607f6468336bed1800113c4;hp=2e5f73e8424136c12aa0a5b6e901d31a35c06172;hpb=7fc6e037c86bc268e3af35cb10c622dd62352880;p=docs.git diff --git a/docs/developer-guide/openflow-plugin-project-developer-guide.rst b/docs/developer-guide/openflow-plugin-project-developer-guide.rst index 2e5f73e84..24a4870d1 100644 --- a/docs/developer-guide/openflow-plugin-project-developer-guide.rst +++ b/docs/developer-guide/openflow-plugin-project-developer-guide.rst @@ -14,8 +14,8 @@ Event Sequences Session Establishment ~~~~~~~~~~~~~~~~~~~~~ -The `OpenFlow Protocol -Library <#_openflow_protocol_library_developer_guide>`__ provides +The OpenFlow Protocol +Library provides interface **SwitchConnectionHandler** which contains method *onSwitchConnected* (step 1). This event is raised in the OpenFlow Protocol Library when an OpenFlow device connects to OpenDaylight and @@ -222,7 +222,7 @@ describes the YANG files used to model each module. - and target implementation is assigned (``...OpenflowPluginProvider``) -.. code:: yang +.. code:: module openflow-provider { yang-version 1; @@ -259,7 +259,7 @@ describes the YANG files used to model each module. provided by openflowjava, one plugin instance will orchestrate multiple openflowjava modules) -.. code:: yang +.. code:: module openflow-provider-impl { yang-version 1; @@ -375,10 +375,6 @@ In order to involve suitable code generators, this is needed in pom: - sal CodeGeneratorImpl (target/generated-sources/sal) -- documentation generator (target/site/models): - `openflow-provider.html `__, - `openflow-provider-impl.html `__ - Altering generated files ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1027,402 +1023,161 @@ txEntity from EOS. Yang models and API ------------------- -+--------------------------------------------------------+-------------------+ -| Model | DOC | -+========================================================+===================+ ++--------------------------------------------------------+ +| Model | ++========================================================+ | ***Openflow basic types*** | -+--------------------------------------------------------+-------------------+ -| `opendaylight-table-types.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-base/t | -| | arget/site/models | -| | /opendaylight-tab | -| | le-types.html>`__ | -+--------------------------------------------------------+-------------------+ -| `opendaylight-action-types.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-base/t | -| | arget/site/models | -| | /opendaylight-act | -| | ion-types.html>`_ | -| | _ | -+--------------------------------------------------------+-------------------+ -| `opendaylight-flow-types.yan `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-base/t | -| | arget/site/models | -| | /opendaylight-flo | -| | w-types.html>`__ | -+--------------------------------------------------------+-------------------+ -| `opendaylight-meter-types.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-base/t | -| | arget/site/models | -| | /opendaylight-met | -| | er-types.html>`__ | -+--------------------------------------------------------+-------------------+ -| `opendaylight-group-types.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-base/t | -| | arget/site/models | -| | /opendaylight-gro | -| | up-types.html>`__ | -+--------------------------------------------------------+-------------------+ -| `opendaylight-match-types.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-base/t | -| | arget/site/models | -| | /opendaylight-mat | -| | ch-types.html>`__ | -+--------------------------------------------------------+-------------------+ -| `opendaylight-port-types.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-base/t | -| | arget/site/models | -| | /opendaylight-por | -| | t-types.html>`__ | -+--------------------------------------------------------+-------------------+ -| `opendaylight-queue-types.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-base/t | -| | arget/site/models | -| | /opendaylight-que | -| | ue-types.html>`__ | -+--------------------------------------------------------+-------------------+ ++--------------------------------------------------------+ +| `opendaylight-table-types.yang `__ | ++--------------------------------------------------------+ +| `opendaylight-action-types.yang `__ | ++--------------------------------------------------------+ +| `opendaylight-flow-types.yang `__ | ++--------------------------------------------------------+ +| `opendaylight-meter-types.yang `__ | ++--------------------------------------------------------+ +| `opendaylight-group-types.yang `__ | ++--------------------------------------------------------+ +| `opendaylight-match-types.yang `__ | ++--------------------------------------------------------+ +| `opendaylight-port-types.yang `__ | ++--------------------------------------------------------+ +| `opendaylight-queue-types.yang `__ | ++--------------------------------------------------------+ | ***Openflow services*** | -+--------------------------------------------------------+-------------------+ -| `sal-table.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-servic | -| | e/target/site/mod | -| | els/sal-table.htm | -| | l>`__ | -+--------------------------------------------------------+-------------------+ -| `sal-group.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-servic | -| | e/target/site/mod | -| | els/sal-group.htm | -| | l>`__ | -+--------------------------------------------------------+-------------------+ -| `sal-queue.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-servic | -| | e/target/site/mod | -| | els/sal-queue.htm | -| | l>`__ | -+--------------------------------------------------------+-------------------+ -| `flow-errors.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-servic | -| | e/target/site/mod | -| | els/flow-errors.h | -| | tml>`__ | -+--------------------------------------------------------+-------------------+ -| `flow-capable-transaction.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-servic | -| | e/target/site/mod | -| | els/flow-capable- | -| | transaction.html> | -| | `__ | -+--------------------------------------------------------+-------------------+ -| `sal-flow.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-servic | -| | e/target/site/mod | -| | els/sal-flow.html | -| | >`__ | -+--------------------------------------------------------+-------------------+ -| `sal-meter.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-servic | -| | e/target/site/mod | -| | els/sal-meter.htm | -| | l>`__ | -+--------------------------------------------------------+-------------------+ -| `flow-topology-discovery.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-servic | -| | e/target/site/mod | -| | els/flow-topology | -| | -discovery.html>` | -| | __ | -+--------------------------------------------------------+-------------------+ -| `node-errors.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-servic | -| | e/target/site/mod | -| | els/node-errors.h | -| | tml>`__ | -+--------------------------------------------------------+-------------------+ -| `node-config.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-servic | -| | e/target/site/mod | -| | els/node-config.h | -| | tml>`__ | -+--------------------------------------------------------+-------------------+ -| `sal-echo.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-servic | -| | e/target/site/mod | -| | els/sal-echo.html | -| | >`__ | -+--------------------------------------------------------+-------------------+ -| `sal-port.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-servic | -| | e/target/site/mod | -| | els/sal-port.html | -| | >`__ | -+--------------------------------------------------------+-------------------+ -| `packet-processing.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-servic | -| | e/target/site/mod | -| | els/packet-proces | -| | sing.html>`__ | -+--------------------------------------------------------+-------------------+ -| `flow-node-inventory.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-servic | -| | e/target/site/mod | -| | els/flow-node-inv | -| | entory.html>`__ | -+--------------------------------------------------------+-------------------+ ++--------------------------------------------------------+ +| `sal-table.yang `__ | ++--------------------------------------------------------+ +| `sal-group.yang `__ | ++--------------------------------------------------------+ +| `sal-queue.yang `__ | ++--------------------------------------------------------+ +| `flow-errors.yang `__ | ++--------------------------------------------------------+ +| `flow-capable-transaction.yang `__ | ++--------------------------------------------------------+ +| `sal-flow.yang `__ | ++--------------------------------------------------------+ +| `sal-meter.yang `__ | ++--------------------------------------------------------+ +| `flow-topology-discovery.yang `__ | ++--------------------------------------------------------+ +| `node-errors.yang `__ | ++--------------------------------------------------------+ +| `node-config.yang `__ | ++--------------------------------------------------------+ +| `sal-echo.yang `__ | ++--------------------------------------------------------+ +| `sal-port.yang `__ | ++--------------------------------------------------------+ +| `packet-processing.yang `__ | ++--------------------------------------------------------+ +| `flow-node-inventory.yang `__ | ++--------------------------------------------------------+ | ***Openflow statistics*** | -+--------------------------------------------------------+-------------------+ -| `opendaylight-queue-statistics.yang `_ | iew/openflowplugi | -| _ | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-statis | -| | tics/target/site/ | -| | models/opendaylig | -| | ht-queue-statisti | -| | cs.html>`__ | -+--------------------------------------------------------+-------------------+ -| `opendaylight-flow-table-statistics.yang `__ | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-statis | -| | tics/target/site/ | -| | models/opendaylig | -| | ht-flow-table-sta | -| | tistics.html>`__ | -+--------------------------------------------------------+-------------------+ -| `opendaylight-port-statistics.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-statis | -| | tics/target/site/ | -| | models/opendaylig | -| | ht-port-statistic | -| | s.html>`__ | -+--------------------------------------------------------+-------------------+ -| `opendaylight-statistics-types.yang `_ | iew/openflowplugi | -| _ | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-statis | -| | tics/target/site/ | -| | models/opendaylig | -| | ht-statistics-typ | -| | es.html>`__ | -+--------------------------------------------------------+-------------------+ -| `opendaylight-group-statistics.yang `_ | iew/openflowplugi | -| _ | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-statis | -| | tics/target/site/ | -| | models/opendaylig | -| | ht-group-statisti | -| | cs.html>`__ | -+--------------------------------------------------------+-------------------+ -| `opendaylight-flow-statistics.yang `__ | iew/openflowplugi | -| | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-statis | -| | tics/target/site/ | -| | models/opendaylig | -| | ht-flow-statistic | -| | s.html>`__ | -+--------------------------------------------------------+-------------------+ -| `opendaylight-meter-statistics.yang `_ | iew/openflowplugi | -| _ | n/job/openflowplu | -| | gin-merge-boron/l | -| | astSuccessfulBuil | -| | d/artifact/model/ | -| | model-flow-statis | -| | tics/target/site/ | -| | models/opendaylig | -| | ht-meter-statisti | -| | cs.html>`__ | -+--------------------------------------------------------+-------------------+ ++--------------------------------------------------------+ +| `opendaylight-queue-statistics.yang `_ | ++--------------------------------------------------------+ +| `opendaylight-flow-table-statistics.yang `__ | ++--------------------------------------------------------+ +| `opendaylight-port-statistics.yang `__ | ++--------------------------------------------------------+ +| `opendaylight-statistics-types.yang `_ | ++--------------------------------------------------------+ +| `opendaylight-group-statistics.yang `_ | ++--------------------------------------------------------+ +| `opendaylight-flow-statistics.yang `__ | ++--------------------------------------------------------+ +| `opendaylight-meter-statistics.yang `_ | ++--------------------------------------------------------+ Karaf feature tree ------------------ @@ -1442,8 +1197,8 @@ Wiring up notifications Introduction ~~~~~~~~~~~~ -We need to translate OpenFlow messages coming up from the `OpenFlow -Protocol Library <#_openflow_protocol_library_developer_guide>`__ into +We need to translate OpenFlow messages coming up from the OpenFlow +Protocol Library into MD-SAL Notification objects and then publish them to the MD-SAL. Mechanics @@ -1554,4 +1309,3 @@ processor cores on machine it is run, e.g., 8 threads if the machine has While each device is assigned to one thread, multiple devices can be assigned to the same thread. -