ONOSFW-171

O/S-SFC-ONOS scenario documentation

Change-Id: I51ae1cf736ea24ab6680f8edca1b2bf5dd598365
Signed-off-by: CNlucius <lukai1@huawei.com>

26 files changed, 0 insertions, 484 deletions

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 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-  ~ Copyright 2014 Open Networking Laboratory
-  ~
-  ~ Licensed under the Apache License, Version 2.0 (the "License");
-  ~ you may not use this file except in compliance with the License.
-  ~ You may obtain a copy of the License at
-  ~
-  ~     http://www.apache.org/licenses/LICENSE-2.0
-  ~
-  ~ Unless required by applicable law or agreed to in writing, software
-  ~ distributed under the License is distributed on an "AS IS" BASIS,
-  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  ~ See the License for the specific language governing permissions and
-  ~ limitations under the License.
-  -->
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-    <modelVersion>4.0.0</modelVersion>
-
-    <prerequisites>
-        <maven>3.0.0</maven>
-    </prerequisites>
-
-    <parent>
-        <groupId>org.onosproject</groupId>
-        <artifactId>onos</artifactId>
-        <version>1.4.0-rc1</version>
-        <relativePath>../pom.xml</relativePath>
-    </parent>
-
-    <artifactId>onos-docs-external</artifactId>
-    <packaging>pom</packaging>
-
-    <description>ONOS Java API documentation</description>
-
-    <modules>
-        <module>..</module>
-    </modules>
-
-    <url>http://onosproject.org/</url>
-
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-javadoc-plugin</artifactId>
-                <configuration>
-                    <show>package</show>
-                    <excludePackageNames>@external-excludes</excludePackageNames>
-                    <sourceFileExcludes>
-                        <sourceFileExclude>**/generated-sources/**</sourceFileExclude>
-                    </sourceFileExcludes>
-                    <docfilessubdirs>true</docfilessubdirs>
-                    <doctitle>ONOS Java API (1.4.0-rc1)</doctitle>
-                    <groups>
-                        <group>
-                            <title>Network Model &amp; Services</title>
-                            <packages>@external-apis</packages>
-                        </group>
-                        <group>
-                            <title>Incubator for Network Model &amp; Services
-                            </title>
-                            <packages>@external-incubator-apis</packages>
-                        </group>
-                        <group>
-                            <title>Utilities</title>
-                            <packages>@utils</packages>
-                        </group>
-                    </groups>
-                    <tags>
-                        <tag>
-                            <name>onos.rsModel</name>
-                            <placement>m</placement>
-                            <head>Json model for REST api:</head>
-                        </tag>
-                    </tags>
-                </configuration>
-            </plugin>
-        </plugins>
-    </build>
-
-</project>
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 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-  ~ Copyright 2014 Open Networking Laboratory
-  ~
-  ~ Licensed under the Apache License, Version 2.0 (the "License");
-  ~ you may not use this file except in compliance with the License.
-  ~ You may obtain a copy of the License at
-  ~
-  ~     http://www.apache.org/licenses/LICENSE-2.0
-  ~
-  ~ Unless required by applicable law or agreed to in writing, software
-  ~ distributed under the License is distributed on an "AS IS" BASIS,
-  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  ~ See the License for the specific language governing permissions and
-  ~ limitations under the License.
-  -->
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-    <modelVersion>4.0.0</modelVersion>
-
-    <prerequisites>
-        <maven>3.0.0</maven>
-    </prerequisites>
-
-    <parent>
-        <groupId>org.onosproject</groupId>
-        <artifactId>onos</artifactId>
-        <version>1.4.0-rc1</version>
-        <relativePath>../pom.xml</relativePath>
-    </parent>
-
-    <artifactId>onos-docs</artifactId>
-    <packaging>pom</packaging>
-
-    <description>ONOS Java API documentation</description>
-
-    <modules>
-        <module>..</module>
-    </modules>
-
-    <url>http://onosproject.org/</url>
-
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-javadoc-plugin</artifactId>
-                <configuration>
-                    <show>package</show>
-                    <docfilessubdirs>true</docfilessubdirs>
-                    <doctitle>ONOS Java API (1.4.0-rc1)</doctitle>
-                    <excludePackageNames>@internal-excludes</excludePackageNames>
-                    <sourceFileExcludes>
-                        <sourceFileExclude>**/generated-sources/**</sourceFileExclude>
-                    </sourceFileExcludes>
-
-                    <groups>
-                        <group>
-                            <title>Network Model &amp; Services</title>
-                            <packages>@internal-apis</packages>
-                        </group>
-                        <group>
-                            <title>Incubator for Network Model &amp; Services
-                            </title>
-                            <packages>@internal-incubator-apis</packages>
-                        </group>
-                        <group>
-                            <title>Core Subsystems</title>
-                            <packages>@internal-core</packages>
-                        </group>
-                        <group>
-                            <title>Distributed Stores</title>
-                            <packages>@internal-stores</packages>
-                        </group>
-                        <group>
-                            <title>Incubator for Core Subsystems &amp;
-                                Distributed Stores
-                            </title>
-                            <packages>@internal-incubator</packages>
-                        </group>
-                        <group>
-                            <title>OpenFlow Providers &amp; Controller</title>
-                            <packages>@internal-openflow</packages>
-                        </group>
-                        <group>
-                            <title>NetConf Providers</title>
-                            <packages>@internal-netconf</packages>
-                        </group>
-                        <group>
-                            <title>OVSDB Providers</title>
-                            <packages>@internal-ovsdb</packages>
-                        </group>
-                        <group>
-                            <title>PCEP Providers</title>
-                            <packages>@internal-pcep</packages>
-                        </group>
-                        <group>
-                            <title>BGP-LS Providers</title>
-                            <packages>@internal-bgpls</packages>
-                        </group>
-                        <group>
-                            <title>Other Providers</title>
-                            <packages>@internal-providers</packages>
-                        </group>
-                        <group>
-                            <title>Built-in Device Drivers</title>
-                            <packages>@internal-drivers</packages>
-                        </group>
-                        <group>
-                            <title>Utilities</title>
-                            <packages>@utils</packages>
-                        </group>
-                        <group>
-                            <title>GUI, REST &amp; Command-Line</title>
-                            <packages>@internal-gui-rest-cli</packages>
-                        </group>
-                        <group>
-                            <title>Builtin Applications</title>
-                            <packages>@internal-apps</packages>
-                        </group>
-                        <group>
-                            <title>Test Instrumentation &amp; Applications
-                            </title>
-                            <packages>@internal-test-apps</packages>
-                        </group>
-                    </groups>
-                    <tags>
-                        <tag>
-                            <name>onos.rsModel</name>
-                            <placement>m</placement>
-                            <head>Json model for REST api:</head>
-                        </tag>
-                    </tags>
-                </configuration>
-            </plugin>
-        </plugins>
-    </build>
-
-</project>
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
--- a/framework/src/onos/docs/src/main/javadoc/doc-files/onos-subsystem.png
+++ /dev/null
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
--- a/framework/src/onos/docs/src/main/javadoc/doc-files/onos-subsystems.png
+++ /dev/null
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
--- a/framework/src/onos/docs/src/main/javadoc/doc-files/onos-tiers.png
+++ /dev/null
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 @@
-<!--
-  ~ Copyright 2014 Open Networking Laboratory
-  ~
-  ~ Licensed under the Apache License, Version 2.0 (the "License");
-  ~ you may not use this file except in compliance with the License.
-  ~ You may obtain a copy of the License at
-  ~
-  ~     http://www.apache.org/licenses/LICENSE-2.0
-  ~
-  ~ Unless required by applicable law or agreed to in writing, software
-  ~ distributed under the License is distributed on an "AS IS" BASIS,
-  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  ~ See the License for the specific language governing permissions and
-  ~ limitations under the License.
-  -->
-<html>
-<body>
-<p>
-    ONOS architecture is strictly segmented into a <em>protocol-agnostic system
-    core</em> tier and the <em>protocol-aware providers</em> tier as shown in
-    the figure below:<br>
-    <img src="doc-files/onos-tiers.png" alt="ONOS architecture tiers">
-</p>
-
-<p>
-    The <em>ONOS core</em> 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.
-</p>
-
-<p>
-    The <em>protocol-aware providers</em> 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.
-</p>
-
-<p>
-    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.<br>
-    <img src="doc-files/onos-subsystems.png" alt="ONOS architecture tiers">
-
-</p>
-
-<p>
-    The following diagram describes the general structure of each ONOS subsystem:
-    <br>
-    <img src="doc-files/onos-subsystem.png" alt="ONOS subsystem structure"><br>
-    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.
-</p>
-
-<p>
-    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.
-</p>
-
-<p>
-    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}.
-</p>
-
-<p>
-    Similar structure applies to the link subsystem, host subsystem and others.
-</p>
-
-<p>
-    <em>More information to come later...</em>
-</p>
-
-</body>
-</html>
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.*