Merge "Remove all references to DLUX"
[docs.git] / docs / user-guide / ocp-plugin-user-guide.rst
index a9b4fb4e984f0190f2c300c6815668d79180d48c..dc4096cf564d53f874419aaf469ac713852109a8 100644 (file)
@@ -1,3 +1,5 @@
+.. _ocpplugin-user-guide:
+
 OCP Plugin User Guide
 =====================
 
@@ -54,15 +56,15 @@ The OCP Plugin project includes:
 
    -  Fault management
 
-   -  Software management (not implemented as of Boron)
+   -  Software management (not yet implemented)
 
 -  Indication processing
 
--  Logging (not implemented as of Boron)
+-  Logging (not yet implemented)
 
--  AISG/Iuant interface message tunnelling (not implemented as of Boron)
+-  AISG/Iuant interface message tunnelling (not yet implemented)
 
--  ALD connection management (not implemented as of Boron)
+-  ALD connection management (not yet implemented)
 
 Architecture and Design
 -----------------------
@@ -149,13 +151,12 @@ southbound (odl-ocpplugin-southbound) and OCP protocol library
 (odl-ocpjava-protocol), provides OpenDaylight with basic OCP v4.1.1
 functionality.
 
-There are two ways to interact with OCP service: one is via RESTCONF
-(programmatic) and the other is using DLUX web interface (manual), so
-you have to install the following features to enable RESTCONF and DLUX.
+You can interact with OCP service via RESTCONF, so you have to install
+the following features to enable RESTCONF.
 
 ::
 
-    karaf#>feature:install odl-restconf odl-l2switch-switch odl-mdsal-apidocs odl-dlux-core odl-dlux-all
+    karaf#>feature:install odl-restconf odl-l2switch-switch odl-mdsal-apidocs
 
 Then install the odl-ocpplugin-all feature which includes the
 odl-ocpplugin-southbound and odl-ocpplugin-app-ocp-service features.
@@ -182,7 +183,7 @@ Configuring the OCP plugin can be done via its configuration file,
 62-ocpplugin.xml, which can be found in the
 <odl-install-dir>/etc/opendaylight/karaf/ directory.
 
-As of Boron, there are the following settings that are configurable:
+There are the following settings that are configurable:
 
 1. **port** specifies the port number on which the OCP plugin listens
    for connection requests
@@ -219,7 +220,7 @@ from OpenDaylight Nexus Repository.
 
 ::
 
-    wget https://nexus.opendaylight.org/content/repositories/opendaylight.release/org/opendaylight/ocpplugin/simple-agent/0.1.0-Boron/simple-agent-0.1.0-Boron.jar
+    wget https://nexus.opendaylight.org/content/repositories/opendaylight.release/org/opendaylight/ocpplugin/simple-agent/${ocp-version}/simple-agent-${ocp-version}.jar
 
 Then run the agent with no arguments (assuming you already have JDK 1.8
 or above installed) and it should display the usage that lists the
@@ -227,7 +228,7 @@ expected arguments.
 
 ::
 
-    java -classpath simple-agent-0.1.0-Boron.jar org.opendaylight.ocpplugin.OcpAgent
+    java -classpath simple-agent-${ocp-version}.jar org.opendaylight.ocpplugin.OcpAgent
 
     Usage: java org.opendaylight.ocpplugin.OcpAgent <controller's ip address> <port number> <vendor id> <serial number>
 
@@ -235,36 +236,7 @@ Here is an example:
 
 ::
 
-    java -classpath simple-agent-0.1.0-Boron.jar org.opendaylight.ocpplugin.OcpAgent 127.0.0.1 1033 XYZ 123
-
-Web / Graphical Interface
--------------------------
-
-Once you enable the DLUX feature, you can access the Controller GUI
-using following URL.
-
-::
-
-    http://<controller-ip>:8080/index.html
-
-Expand Nodes. You should see all the radio head devices that are
-connected to the controller running at <controller-ip>.
-
-.. figure:: ./images/ocpplugin/dlux-ocp-nodes.jpg
-   :alt: DLUX Nodes
-
-   DLUX Nodes
-
-And expand Yang UI if you want to browse the various northbound APIs
-exposed by the OCP service.
-
-.. figure:: ./images/ocpplugin/dlux-ocp-apis.jpg
-   :alt: DLUX Yang UI
-
-   DLUX Yang UI
-
-For information on how to use these northbound APIs, please refer to the
-OCP Plugin Developer Guide.
+    java -classpath simple-agent-${ocp-version}.jar org.opendaylight.ocpplugin.OcpAgent 127.0.0.1 1033 XYZ 123
 
 Programmatic Interface
 ----------------------
@@ -295,4 +267,3 @@ the form of both northbound and southbound APIs, including:
 
 The API is documented in the OCP Plugin Developer Guide under the
 section Southbound API and Northbound API, respectively.
-