From 13d05bc8458758ee39cb829098241e89616717ee Mon Sep 17 00:00:00 2001 From: Ashlee Young Date: Wed, 9 Sep 2015 22:15:21 -0700 Subject: ONOS checkin based on commit tag e796610b1f721d02f9b0e213cf6f7790c10ecd60 Change-Id: Ife8810491034fe7becdba75dda20de4267bd15cd --- framework/src/onos/docs/external-apis | 3 + framework/src/onos/docs/external-excludes | 51 +++++++++ framework/src/onos/docs/external-incubator-apis | 2 + framework/src/onos/docs/external.xml | 74 +++++++++++++ framework/src/onos/docs/internal-apis | 4 + framework/src/onos/docs/internal-apps | 27 +++++ framework/src/onos/docs/internal-core | 7 ++ framework/src/onos/docs/internal-drivers | 2 + framework/src/onos/docs/internal-excludes | 5 + framework/src/onos/docs/internal-gui-rest-cli | 4 + framework/src/onos/docs/internal-incubator | 9 ++ framework/src/onos/docs/internal-incubator-apis | 1 + framework/src/onos/docs/internal-netconf | 1 + framework/src/onos/docs/internal-openflow | 2 + framework/src/onos/docs/internal-ovsdb | 2 + framework/src/onos/docs/internal-pcep | 2 + framework/src/onos/docs/internal-providers | 1 + framework/src/onos/docs/internal-stores | 1 + framework/src/onos/docs/internal-test-apps | 7 ++ framework/src/onos/docs/internal.xml | 122 +++++++++++++++++++++ .../src/main/javadoc/doc-files/onos-subsystem.png | Bin 0 -> 143486 bytes .../src/main/javadoc/doc-files/onos-subsystems.png | Bin 0 -> 104673 bytes .../docs/src/main/javadoc/doc-files/onos-tiers.png | Bin 0 -> 42953 bytes .../src/onos/docs/src/main/javadoc/overview.html | 90 +++++++++++++++ framework/src/onos/docs/utils | 1 + 25 files changed, 418 insertions(+) create mode 100644 framework/src/onos/docs/external-apis create mode 100644 framework/src/onos/docs/external-excludes create mode 100644 framework/src/onos/docs/external-incubator-apis create mode 100644 framework/src/onos/docs/external.xml create mode 100644 framework/src/onos/docs/internal-apis create mode 100644 framework/src/onos/docs/internal-apps create mode 100644 framework/src/onos/docs/internal-core create mode 100644 framework/src/onos/docs/internal-drivers create mode 100644 framework/src/onos/docs/internal-excludes create mode 100644 framework/src/onos/docs/internal-gui-rest-cli create mode 100644 framework/src/onos/docs/internal-incubator create mode 100644 framework/src/onos/docs/internal-incubator-apis create mode 100644 framework/src/onos/docs/internal-netconf create mode 100644 framework/src/onos/docs/internal-openflow create mode 100644 framework/src/onos/docs/internal-ovsdb create mode 100644 framework/src/onos/docs/internal-pcep create mode 100644 framework/src/onos/docs/internal-providers create mode 100644 framework/src/onos/docs/internal-stores create mode 100644 framework/src/onos/docs/internal-test-apps create mode 100644 framework/src/onos/docs/internal.xml create mode 100644 framework/src/onos/docs/src/main/javadoc/doc-files/onos-subsystem.png create mode 100644 framework/src/onos/docs/src/main/javadoc/doc-files/onos-subsystems.png create mode 100644 framework/src/onos/docs/src/main/javadoc/doc-files/onos-tiers.png create mode 100644 framework/src/onos/docs/src/main/javadoc/overview.html create mode 100644 framework/src/onos/docs/utils (limited to 'framework/src/onos/docs') diff --git a/framework/src/onos/docs/external-apis b/framework/src/onos/docs/external-apis new file mode 100644 index 00000000..4e18664b --- /dev/null +++ b/framework/src/onos/docs/external-apis @@ -0,0 +1,3 @@ +org.onosproject +org.onosproject.* +org.onosproject.rest \ No newline at end of file diff --git a/framework/src/onos/docs/external-excludes b/framework/src/onos/docs/external-excludes new file mode 100644 index 00000000..34329f19 --- /dev/null +++ b/framework/src/onos/docs/external-excludes @@ -0,0 +1,51 @@ +*.impl +*.impl.* + +org.onlab.jdvue* +org.onlab.stc* + +org.onlab.thirdparty +org.onosproject.provider* +org.onosproject.rest +org.onosproject.cli* +org.onosproject.tvue +org.onosproject.dhcp +org.onosproject.foo +org.onosproject.mobility +org.onosproject.proxyarp +org.onosproject.fwd +org.onosproject.ifwd +org.onosproject.optical +org.onosproject.config +org.onosproject.calendar +org.onosproject.sdnip* +org.onosproject.oecfg +org.onosproject.metrics +org.onosproject.store.ecmap +org.onosproject.store.flow +org.onosproject.store.serializers* +org.onosproject.openflow* +org.onosproject.common* +org.onosproject.routing* +org.onosproject.bgprouter +org.onosproject.intentperf +org.onosproject.maven +org.onosproject.cordfabric* +org.onosproject.driver* +org.onosproject.segmentrouting* +org.onosproject.reactive* +org.onosproject.distributedprimitives* +org.onosproject.messagingperf* +org.onosproject.virtualbng* +org.onosproject.election* +org.onosproject.demo* +org.onosproject.xosintegration* +org.onosproject.app.vtn* +org.onosproject.ovsdb* +org.onosproject.pcep* +org.onosproject.aaa +org.onosproject.acl* +org.onosproject.cip* +org.onos.acl* +org.onosproject.vtn* +org.onosproject.flowanalyzer diff --git a/framework/src/onos/docs/external-incubator-apis b/framework/src/onos/docs/external-incubator-apis new file mode 100644 index 00000000..1e3bd7a3 --- /dev/null +++ b/framework/src/onos/docs/external-incubator-apis @@ -0,0 +1,2 @@ +org.onosproject.exp +org.onosproject.incubator.* diff --git a/framework/src/onos/docs/external.xml b/framework/src/onos/docs/external.xml new file mode 100644 index 00000000..1f020548 --- /dev/null +++ b/framework/src/onos/docs/external.xml @@ -0,0 +1,74 @@ + + + + 4.0.0 + + + 3.0.0 + + + + org.onosproject + onos + 1.3.0-SNAPSHOT + ../pom.xml + + + onos-docs-external + pom + + ONOS Java API documentation + + + .. + + + http://onosproject.org/ + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.10.1 + + package + @external-excludes + true + ONOS Java API (1.3.0-SNAPSHOT) + + + Network Model & Services + @external-apis + + + Incubator for Network Model & Services + @external-incubator-apis + + + Utilities + @utils + + + + + + + + diff --git a/framework/src/onos/docs/internal-apis b/framework/src/onos/docs/internal-apis new file mode 100644 index 00000000..9d8079a5 --- /dev/null +++ b/framework/src/onos/docs/internal-apis @@ -0,0 +1,4 @@ +org.onosproject +org.onosproject.* +org.onosproject.rest +org.onosproject.security diff --git a/framework/src/onos/docs/internal-apps b/framework/src/onos/docs/internal-apps new file mode 100644 index 00000000..8c4a493f --- /dev/null +++ b/framework/src/onos/docs/internal-apps @@ -0,0 +1,27 @@ +org.onosproject.app.* + +org.onos.acl* +org.onosproject.acl* +org.onosproject.aaa +org.onosproject.fwd +org.onosproject.dhcp* +org.onosproject.flowanalyzer +org.onosproject.mobility +org.onosproject.proxyarp +org.onosproject.calendar +org.onosproject.olt* +org.onosproject.optical* +org.onosproject.sdnip +org.onosproject.sdnip.* +org.onosproject.config +org.onosproject.routing +org.onosproject.routing* +org.onosproject.bgprouter +org.onosproject.segmentrouting* +org.onosproject.reactive.routing* +org.onosproject.messagingperf +org.onosproject.virtualbng* +org.onosproject.cordfabric* +org.onosproject.xosintegration* +org.onosproject.cip* +org.onosproject.vtn* diff --git a/framework/src/onos/docs/internal-core b/framework/src/onos/docs/internal-core new file mode 100644 index 00000000..8f242822 --- /dev/null +++ b/framework/src/onos/docs/internal-core @@ -0,0 +1,7 @@ +*.impl +*.impl.* + +org.onosproject.json +org.onosproject.json.* +:org.onosproject.common.* +org.onosproject.security.* diff --git a/framework/src/onos/docs/internal-drivers b/framework/src/onos/docs/internal-drivers new file mode 100644 index 00000000..fb2dea44 --- /dev/null +++ b/framework/src/onos/docs/internal-drivers @@ -0,0 +1,2 @@ +org.onosproject.driver +org.onosproject.driver.* diff --git a/framework/src/onos/docs/internal-excludes b/framework/src/onos/docs/internal-excludes new file mode 100644 index 00000000..9876ccea --- /dev/null +++ b/framework/src/onos/docs/internal-excludes @@ -0,0 +1,5 @@ +org.onlab.jdvue* +org.onlab.stc* +org.onlab.thirdparty +org.onosproject.oecfg +org.onosproject.maven diff --git a/framework/src/onos/docs/internal-gui-rest-cli b/framework/src/onos/docs/internal-gui-rest-cli new file mode 100644 index 00000000..7b529c00 --- /dev/null +++ b/framework/src/onos/docs/internal-gui-rest-cli @@ -0,0 +1,4 @@ +org.onosproject.ui.impl* +org.onosproject.rest.* +org.onosproject.cli* +org.onosproject.codec.impl diff --git a/framework/src/onos/docs/internal-incubator b/framework/src/onos/docs/internal-incubator new file mode 100644 index 00000000..619bbb90 --- /dev/null +++ b/framework/src/onos/docs/internal-incubator @@ -0,0 +1,9 @@ +org.onosproject.incubator.net.impl +org.onosproject.incubator.store.impl +org.onosproject.incubator.net.resource.label.impl +org.onosproject.incubator.store.resource.impl +org.onosproject.incubator.net.tunnel.impl +org.onosproject.incubator.store.tunnel.impl +org.onosproject.incubator.net.config.impl +org.onosproject.incubator.net.domain.impl +org.onosproject.incubator.store.config.impl diff --git a/framework/src/onos/docs/internal-incubator-apis b/framework/src/onos/docs/internal-incubator-apis new file mode 100644 index 00000000..df9ddbcc --- /dev/null +++ b/framework/src/onos/docs/internal-incubator-apis @@ -0,0 +1 @@ +org.onosproject.incubator* diff --git a/framework/src/onos/docs/internal-netconf b/framework/src/onos/docs/internal-netconf new file mode 100644 index 00000000..40c159f4 --- /dev/null +++ b/framework/src/onos/docs/internal-netconf @@ -0,0 +1 @@ +org.onosproject.provider.netconf* diff --git a/framework/src/onos/docs/internal-openflow b/framework/src/onos/docs/internal-openflow new file mode 100644 index 00000000..c84cf137 --- /dev/null +++ b/framework/src/onos/docs/internal-openflow @@ -0,0 +1,2 @@ +org.onosproject.openflow.* +org.onosproject.provider.of.* diff --git a/framework/src/onos/docs/internal-ovsdb b/framework/src/onos/docs/internal-ovsdb new file mode 100644 index 00000000..4b4ccb77 --- /dev/null +++ b/framework/src/onos/docs/internal-ovsdb @@ -0,0 +1,2 @@ +org.onosproject.provider.ovsdb* +org.onosproject.ovsdb* diff --git a/framework/src/onos/docs/internal-pcep b/framework/src/onos/docs/internal-pcep new file mode 100644 index 00000000..8d105144 --- /dev/null +++ b/framework/src/onos/docs/internal-pcep @@ -0,0 +1,2 @@ +org.onosproject.pcep* +org.onosproject.pcepio* diff --git a/framework/src/onos/docs/internal-providers b/framework/src/onos/docs/internal-providers new file mode 100644 index 00000000..832fb247 --- /dev/null +++ b/framework/src/onos/docs/internal-providers @@ -0,0 +1 @@ +org.onosproject.provider.* diff --git a/framework/src/onos/docs/internal-stores b/framework/src/onos/docs/internal-stores new file mode 100644 index 00000000..13c00431 --- /dev/null +++ b/framework/src/onos/docs/internal-stores @@ -0,0 +1 @@ +org.onosproject.store.* diff --git a/framework/src/onos/docs/internal-test-apps b/framework/src/onos/docs/internal-test-apps new file mode 100644 index 00000000..bc5276cf --- /dev/null +++ b/framework/src/onos/docs/internal-test-apps @@ -0,0 +1,7 @@ +org.onosproject.metrics.* +org.onosproject.demo* +org.onosproject.election* +org.onosproject.distributedprimitives* +org.onosproject.intentperf* +org.onosproject.messagingperf* +org.onosproject.optical.testapp* diff --git a/framework/src/onos/docs/internal.xml b/framework/src/onos/docs/internal.xml new file mode 100644 index 00000000..bcb1215d --- /dev/null +++ b/framework/src/onos/docs/internal.xml @@ -0,0 +1,122 @@ + + + + 4.0.0 + + + 3.0.0 + + + + org.onosproject + onos + 1.3.0-SNAPSHOT + ../pom.xml + + + onos-docs + pom + + ONOS Java API documentation + + + .. + + + http://onosproject.org/ + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.10.3 + + package + true + ONOS Java API (1.3.0-SNAPSHOT) + @internal-excludes + + + Network Model & Services + @internal-apis + + + Incubator for Network Model & Services + @internal-incubator-apis + + + Core Subsystems + @internal-core + + + Distributed Stores + @internal-stores + + + Incubator for Core Subsystems & Distributed Stores + @internal-incubator + + + OpenFlow Providers & Controller + @internal-openflow + + + NetConf Providers + @internal-netconf + + + OVSDB Providers + @internal-ovsdb + + + PCEP Providers + @internal-pcep + + + Other Providers + @internal-providers + + + Built-in Device Drivers + @internal-drivers + + + Utilities + @utils + + + GUI, REST & Command-Line + @internal-gui-rest-cli + + + Builtin Applications + @internal-apps + + + Test Instrumentation & Applications + @internal-test-apps + + + + + + + + diff --git a/framework/src/onos/docs/src/main/javadoc/doc-files/onos-subsystem.png b/framework/src/onos/docs/src/main/javadoc/doc-files/onos-subsystem.png new file mode 100644 index 00000000..1b16b0b5 Binary files /dev/null and b/framework/src/onos/docs/src/main/javadoc/doc-files/onos-subsystem.png differ diff --git a/framework/src/onos/docs/src/main/javadoc/doc-files/onos-subsystems.png b/framework/src/onos/docs/src/main/javadoc/doc-files/onos-subsystems.png new file mode 100644 index 00000000..a6100c52 Binary files /dev/null and b/framework/src/onos/docs/src/main/javadoc/doc-files/onos-subsystems.png differ diff --git a/framework/src/onos/docs/src/main/javadoc/doc-files/onos-tiers.png b/framework/src/onos/docs/src/main/javadoc/doc-files/onos-tiers.png new file mode 100644 index 00000000..bbacfc8d Binary files /dev/null and b/framework/src/onos/docs/src/main/javadoc/doc-files/onos-tiers.png differ diff --git a/framework/src/onos/docs/src/main/javadoc/overview.html b/framework/src/onos/docs/src/main/javadoc/overview.html new file mode 100644 index 00000000..d3712ab4 --- /dev/null +++ b/framework/src/onos/docs/src/main/javadoc/overview.html @@ -0,0 +1,90 @@ + + + +

+ ONOS architecture is strictly segmented into a protocol-agnostic system + core tier and the protocol-aware providers tier as shown in + the figure below:
+ ONOS architecture tiers +

+ +

+ The ONOS core is responsible for tracking information about the + network environment and distributing it to the applications either + synchronously via query or asynchronously via listener callbacks. The + core is also responsible for persisting select state and synchronizing state + among the cluster peers. +

+ +

+ The protocol-aware providers are responsible for interacting with + the network environment using various control and configuration protocols + and supplying such sensory data to the core. Some providers may also need to + accept control edicts from the core and apply them to the environment + using the appropriate protocol-specific means. +

+ +

+ The figure below provides a visual inventory of the various ONOS subsystems. + The ones with the gray outline represent either work in progress features + planned for release in 2015.
+ ONOS architecture tiers + +

+ +

+ The following diagram describes the general structure of each ONOS subsystem: +
+ ONOS subsystem structure
+ For example, the device-subsystem comprises of a core + {@link org.onosproject.net.device.impl.DeviceManager}, + which exposes a north-bound + {@link org.onosproject.net.device.DeviceService} through which applications or other core components + can learn about the global infrastructure device inventory and through + which they can also subscribe for asynchronous {@link org.onosproject.net.device.DeviceEvent} + notifications via the {@link org.onosproject.net.device.DeviceListener} mechanism. A set of + administrative actions can be performed via {@link org.onosproject.net.device.DeviceAdminService}, + e.g. setting mastership role, removing a decommissioned device. +

+ +

+ On the south-bound side, the core {@link org.onosproject.net.device.impl.DeviceManager} + exposes a {@link org.onosproject.net.device.DeviceProviderRegistry} through which any number of + {@link org.onosproject.net.device.DeviceProvider} entities can register and in turn obtain a + {@link org.onosproject.net.device.DeviceProviderService}. Device and port information can then be + supplied to the core by each provider through the provider service issued + to them. When a provider unregisters, its {@link org.onosproject.net.device.DeviceProviderService} + will be invalidated and can no longer be used for interacting with the + core. +

+ +

+ Within the core, the tasks of indexing, persisting and synchronizing the + global device and port state with the cluster peers falls on the + {@link org.onosproject.net.device.DeviceStore}. +

+ +

+ Similar structure applies to the link subsystem, host subsystem and others. +

+ +

+ More information to come later... +

+ + + diff --git a/framework/src/onos/docs/utils b/framework/src/onos/docs/utils new file mode 100644 index 00000000..b4efc06f --- /dev/null +++ b/framework/src/onos/docs/utils @@ -0,0 +1 @@ +org.onlab.* -- cgit 1.2.3-korg