From b731e2f1dd0972409b136aebc7b463dd72c9cfad Mon Sep 17 00:00:00 2001 From: CNlucius Date: Tue, 13 Sep 2016 11:40:12 +0800 Subject: ONOSFW-171 O/S-SFC-ONOS scenario documentation Change-Id: I51ae1cf736ea24ab6680f8edca1b2bf5dd598365 Signed-off-by: CNlucius --- framework/src/onos/docs/external-apis | 3 - framework/src/onos/docs/external-excludes | 56 --------- framework/src/onos/docs/external-incubator-apis | 2 - framework/src/onos/docs/external.xml | 84 ------------- framework/src/onos/docs/internal-apis | 2 - framework/src/onos/docs/internal-apps | 31 ----- framework/src/onos/docs/internal-bgpls | 2 - framework/src/onos/docs/internal-core | 28 ----- framework/src/onos/docs/internal-drivers | 2 - framework/src/onos/docs/internal-excludes | 7 -- framework/src/onos/docs/internal-gui-rest-cli | 4 - framework/src/onos/docs/internal-incubator | 13 -- framework/src/onos/docs/internal-incubator-apis | 1 - framework/src/onos/docs/internal-netconf | 2 - 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 | 2 - framework/src/onos/docs/internal-test-apps | 7 -- framework/src/onos/docs/internal.xml | 140 --------------------- .../src/main/javadoc/doc-files/onos-subsystem.png | Bin 143486 -> 0 bytes .../src/main/javadoc/doc-files/onos-subsystems.png | Bin 104673 -> 0 bytes .../docs/src/main/javadoc/doc-files/onos-tiers.png | Bin 42953 -> 0 bytes .../src/onos/docs/src/main/javadoc/overview.html | 90 ------------- framework/src/onos/docs/utils | 1 - 26 files changed, 484 deletions(-) delete mode 100644 framework/src/onos/docs/external-apis delete mode 100644 framework/src/onos/docs/external-excludes delete mode 100644 framework/src/onos/docs/external-incubator-apis delete mode 100644 framework/src/onos/docs/external.xml delete mode 100644 framework/src/onos/docs/internal-apis delete mode 100644 framework/src/onos/docs/internal-apps delete mode 100644 framework/src/onos/docs/internal-bgpls delete mode 100644 framework/src/onos/docs/internal-core delete mode 100644 framework/src/onos/docs/internal-drivers delete mode 100644 framework/src/onos/docs/internal-excludes delete mode 100644 framework/src/onos/docs/internal-gui-rest-cli delete mode 100644 framework/src/onos/docs/internal-incubator delete mode 100644 framework/src/onos/docs/internal-incubator-apis delete mode 100644 framework/src/onos/docs/internal-netconf delete mode 100644 framework/src/onos/docs/internal-openflow delete mode 100644 framework/src/onos/docs/internal-ovsdb delete mode 100644 framework/src/onos/docs/internal-pcep delete mode 100644 framework/src/onos/docs/internal-providers delete mode 100644 framework/src/onos/docs/internal-stores delete mode 100644 framework/src/onos/docs/internal-test-apps delete mode 100644 framework/src/onos/docs/internal.xml delete mode 100644 framework/src/onos/docs/src/main/javadoc/doc-files/onos-subsystem.png delete mode 100644 framework/src/onos/docs/src/main/javadoc/doc-files/onos-subsystems.png delete mode 100644 framework/src/onos/docs/src/main/javadoc/doc-files/onos-tiers.png delete mode 100644 framework/src/onos/docs/src/main/javadoc/overview.html delete 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 deleted file mode 100644 index 4e18664b..00000000 --- a/framework/src/onos/docs/external-apis +++ /dev/null @@ -1,3 +0,0 @@ -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 deleted file mode 100644 index 8b8a3d50..00000000 --- a/framework/src/onos/docs/external-excludes +++ /dev/null @@ -1,56 +0,0 @@ -*.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.onosproject.acl* -org.onosproject.vtn* -org.onosproject.cord* -org.onosproject.mfwd* -org.onosproject.mcast* -org.onosproject.flowanalyzer -org.onosproject.grpc* -protobuf.* diff --git a/framework/src/onos/docs/external-incubator-apis b/framework/src/onos/docs/external-incubator-apis deleted file mode 100644 index 1e3bd7a3..00000000 --- a/framework/src/onos/docs/external-incubator-apis +++ /dev/null @@ -1,2 +0,0 @@ -org.onosproject.exp -org.onosproject.incubator.* diff --git a/framework/src/onos/docs/external.xml b/framework/src/onos/docs/external.xml deleted file mode 100644 index 04c18d2d..00000000 --- a/framework/src/onos/docs/external.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - 4.0.0 - - - 3.0.0 - - - - org.onosproject - onos - 1.4.0-rc1 - ../pom.xml - - - onos-docs-external - pom - - ONOS Java API documentation - - - .. - - - http://onosproject.org/ - - - - - org.apache.maven.plugins - maven-javadoc-plugin - - package - @external-excludes - - **/generated-sources/** - - true - ONOS Java API (1.4.0-rc1) - - - Network Model & Services - @external-apis - - - Incubator for Network Model & Services - - @external-incubator-apis - - - Utilities - @utils - - - - - onos.rsModel - m - Json model for REST api: - - - - - - - - diff --git a/framework/src/onos/docs/internal-apis b/framework/src/onos/docs/internal-apis deleted file mode 100644 index a35d093c..00000000 --- a/framework/src/onos/docs/internal-apis +++ /dev/null @@ -1,2 +0,0 @@ -org.onosproject -org.onosproject.* diff --git a/framework/src/onos/docs/internal-apps b/framework/src/onos/docs/internal-apps deleted file mode 100644 index c930c05f..00000000 --- a/framework/src/onos/docs/internal-apps +++ /dev/null @@ -1,31 +0,0 @@ -org.onosproject.app.* - -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* -org.onosproject.cord* -org.onosproject.mcast* -org.onosproject.mfwd* -org.onosproject.mlb* -org.onosproject.igmp.impl diff --git a/framework/src/onos/docs/internal-bgpls b/framework/src/onos/docs/internal-bgpls deleted file mode 100644 index f264c7db..00000000 --- a/framework/src/onos/docs/internal-bgpls +++ /dev/null @@ -1,2 +0,0 @@ -org.onosproject.bgp.controller* -org.onosproject.bgpio* diff --git a/framework/src/onos/docs/internal-core b/framework/src/onos/docs/internal-core deleted file mode 100644 index f987aa94..00000000 --- a/framework/src/onos/docs/internal-core +++ /dev/null @@ -1,28 +0,0 @@ -org.onosproject.cfg.impl -org.onosproject.cluster.impl -org.onosproject.core.impl -org.onosproject.event.impl -org.onosproject.net.config.impl -org.onosproject.net.device.impl -org.onosproject.net.driver.impl -org.onosproject.net.edgeservice.impl -org.onosproject.net.flow.impl -org.onosproject.net.flowobjective.impl -org.onosproject.net.flowobjective.impl.composition -org.onosproject.net.group.impl -org.onosproject.net.host.impl -org.onosproject.net.intent.impl -org.onosproject.net.intent.impl.compiler -org.onosproject.net.intent.impl.phase -org.onosproject.net.link.impl -org.onosproject.net.newresource.impl -org.onosproject.net.packet.impl -org.onosproject.net.proxyarp.impl -org.onosproject.net.resource.impl -org.onosproject.net.statistic.impl -org.onosproject.net.topology.impl -org.onosproject.json -org.onosproject.json.* -org.onosproject.common.* -org.onosproject.security.impl -org.onosproject.security.store diff --git a/framework/src/onos/docs/internal-drivers b/framework/src/onos/docs/internal-drivers deleted file mode 100644 index fb2dea44..00000000 --- a/framework/src/onos/docs/internal-drivers +++ /dev/null @@ -1,2 +0,0 @@ -org.onosproject.driver -org.onosproject.driver.* diff --git a/framework/src/onos/docs/internal-excludes b/framework/src/onos/docs/internal-excludes deleted file mode 100644 index 2ae8a261..00000000 --- a/framework/src/onos/docs/internal-excludes +++ /dev/null @@ -1,7 +0,0 @@ -org.onlab.jdvue* -org.onlab.stc* -org.onlab.thirdparty -org.onosproject.oecfg -org.onosproject.maven -org.onosproject.grpc* -protobuf.* diff --git a/framework/src/onos/docs/internal-gui-rest-cli b/framework/src/onos/docs/internal-gui-rest-cli deleted file mode 100644 index 7b529c00..00000000 --- a/framework/src/onos/docs/internal-gui-rest-cli +++ /dev/null @@ -1,4 +0,0 @@ -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 deleted file mode 100644 index 58179b68..00000000 --- a/framework/src/onos/docs/internal-incubator +++ /dev/null @@ -1,13 +0,0 @@ -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 -org.onosproject.incubator.net.intf.impl -org.onosproject.incubator.net.meter.impl -org.onosproject.incubator.net.resource.label -org.onosproject.incubator.store.meter.impl \ No newline at end of file diff --git a/framework/src/onos/docs/internal-incubator-apis b/framework/src/onos/docs/internal-incubator-apis deleted file mode 100644 index df9ddbcc..00000000 --- a/framework/src/onos/docs/internal-incubator-apis +++ /dev/null @@ -1 +0,0 @@ -org.onosproject.incubator* diff --git a/framework/src/onos/docs/internal-netconf b/framework/src/onos/docs/internal-netconf deleted file mode 100644 index 161ad9cc..00000000 --- a/framework/src/onos/docs/internal-netconf +++ /dev/null @@ -1,2 +0,0 @@ -org.onosproject.netconf* -org.onosproject.provider.netconf* diff --git a/framework/src/onos/docs/internal-openflow b/framework/src/onos/docs/internal-openflow deleted file mode 100644 index c84cf137..00000000 --- a/framework/src/onos/docs/internal-openflow +++ /dev/null @@ -1,2 +0,0 @@ -org.onosproject.openflow.* -org.onosproject.provider.of.* diff --git a/framework/src/onos/docs/internal-ovsdb b/framework/src/onos/docs/internal-ovsdb deleted file mode 100644 index 4b4ccb77..00000000 --- a/framework/src/onos/docs/internal-ovsdb +++ /dev/null @@ -1,2 +0,0 @@ -org.onosproject.provider.ovsdb* -org.onosproject.ovsdb* diff --git a/framework/src/onos/docs/internal-pcep b/framework/src/onos/docs/internal-pcep deleted file mode 100644 index 8d105144..00000000 --- a/framework/src/onos/docs/internal-pcep +++ /dev/null @@ -1,2 +0,0 @@ -org.onosproject.pcep* -org.onosproject.pcepio* diff --git a/framework/src/onos/docs/internal-providers b/framework/src/onos/docs/internal-providers deleted file mode 100644 index 832fb247..00000000 --- a/framework/src/onos/docs/internal-providers +++ /dev/null @@ -1 +0,0 @@ -org.onosproject.provider.* diff --git a/framework/src/onos/docs/internal-stores b/framework/src/onos/docs/internal-stores deleted file mode 100644 index 1f1f05ab..00000000 --- a/framework/src/onos/docs/internal-stores +++ /dev/null @@ -1,2 +0,0 @@ -org.onosproject.store.* -org.onosproject.persistence.impl diff --git a/framework/src/onos/docs/internal-test-apps b/framework/src/onos/docs/internal-test-apps deleted file mode 100644 index bc5276cf..00000000 --- a/framework/src/onos/docs/internal-test-apps +++ /dev/null @@ -1,7 +0,0 @@ -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 deleted file mode 100644 index 42cb80f4..00000000 --- a/framework/src/onos/docs/internal.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - 4.0.0 - - - 3.0.0 - - - - org.onosproject - onos - 1.4.0-rc1 - ../pom.xml - - - onos-docs - pom - - ONOS Java API documentation - - - .. - - - http://onosproject.org/ - - - - - org.apache.maven.plugins - maven-javadoc-plugin - - package - true - ONOS Java API (1.4.0-rc1) - @internal-excludes - - **/generated-sources/** - - - - - 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 - - - BGP-LS Providers - @internal-bgpls - - - 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 - - - - - onos.rsModel - m - Json model for REST api: - - - - - - - - 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 deleted file mode 100644 index 1b16b0b5..00000000 Binary files a/framework/src/onos/docs/src/main/javadoc/doc-files/onos-subsystem.png and /dev/null 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 deleted file mode 100644 index a6100c52..00000000 Binary files a/framework/src/onos/docs/src/main/javadoc/doc-files/onos-subsystems.png and /dev/null 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 deleted file mode 100644 index bbacfc8d..00000000 Binary files a/framework/src/onos/docs/src/main/javadoc/doc-files/onos-tiers.png and /dev/null differ diff --git a/framework/src/onos/docs/src/main/javadoc/overview.html b/framework/src/onos/docs/src/main/javadoc/overview.html deleted file mode 100644 index d3712ab4..00000000 --- a/framework/src/onos/docs/src/main/javadoc/overview.html +++ /dev/null @@ -1,90 +0,0 @@ - - - -

- 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 deleted file mode 100644 index b4efc06f..00000000 --- a/framework/src/onos/docs/utils +++ /dev/null @@ -1 +0,0 @@ -org.onlab.* -- cgit