Restructure CCSDK documentation 51/54651/1
authorTimoney, Dan (dt5972) <dt5972@att.com>
Wed, 13 Jun 2018 15:11:29 +0000 (11:11 -0400)
committerTimoney, Dan (dt5972) <dt5972@att.com>
Wed, 13 Jun 2018 15:11:29 +0000 (11:11 -0400)
Remove empty repo-specific documents in favor of meaningful
project-level documentation.

Change-Id: I18f2db7f68895df2d71450eee7e56723d74f7f5a
Issue-ID: CCSDK-300
Signed-off-by: Timoney, Dan (dt5972) <dt5972@att.com>
38 files changed:
docs/index.rst
docs/sli/adaptors/architecture.rst [deleted file]
docs/sli/adaptors/build.rst [deleted file]
docs/sli/adaptors/index.rst [deleted file]
docs/sli/adaptors/offeredapis.rst [deleted file]
docs/sli/adaptors/release-notes.rst [deleted file]
docs/sli/apis/asdcApi.rst [moved from docs/sli/northbound/apis/asdcApi.rst with 100% similarity]
docs/sli/apis/dataChange.rst [moved from docs/sli/northbound/apis/dataChange.rst with 100% similarity]
docs/sli/apis/sliapi.rst [moved from docs/sli/core/apis/sliapi.rst with 100% similarity]
docs/sli/architecture.rst [new file with mode: 0644]
docs/sli/build.rst [new file with mode: 0644]
docs/sli/core/architecture.rst [deleted file]
docs/sli/core/build.rst [deleted file]
docs/sli/core/index.rst [deleted file]
docs/sli/core/logging.rst [deleted file]
docs/sli/core/offeredapis.rst [deleted file]
docs/sli/core/release-notes.rst [deleted file]
docs/sli/index.rst [moved from docs/sli/northbound/index.rst with 55% similarity]
docs/sli/logging.rst [moved from docs/sli/adaptors/logging.rst with 100% similarity]
docs/sli/nodes.rst [moved from docs/sli/core/nodes.rst with 100% similarity]
docs/sli/northbound/architecture.rst [deleted file]
docs/sli/northbound/build.rst [deleted file]
docs/sli/northbound/logging.rst [deleted file]
docs/sli/northbound/nodes.rst [deleted file]
docs/sli/northbound/release-notes.rst [deleted file]
docs/sli/offeredapis.rst [moved from docs/sli/northbound/offeredapis.rst with 91% similarity]
docs/sli/plugins/architecture.rst [deleted file]
docs/sli/plugins/build.rst [deleted file]
docs/sli/plugins/docs/architecture.rst [deleted file]
docs/sli/plugins/docs/build.rst [deleted file]
docs/sli/plugins/docs/index.rst [deleted file]
docs/sli/plugins/docs/logging.rst [deleted file]
docs/sli/plugins/docs/offeredapis.rst [deleted file]
docs/sli/plugins/docs/release-notes.rst [deleted file]
docs/sli/plugins/index.rst [deleted file]
docs/sli/plugins/logging.rst [deleted file]
docs/sli/plugins/offeredapis.rst [deleted file]
docs/sli/plugins/release-notes.rst [deleted file]

index b53fd39..14a0026 100644 (file)
@@ -6,9 +6,6 @@ Common Controller Software Development Kit
    :maxdepth: 1
 
    platform/plugins/index.rst
-   sli/core/index.rst
-   sli/adaptors/index.rst
-   sli/northbound/index.rst
-   sli/plugins/index.rst
+   sli/index.rst
    release-notes.rst
 
diff --git a/docs/sli/adaptors/architecture.rst b/docs/sli/adaptors/architecture.rst
deleted file mode 100644 (file)
index 8daa0d3..0000000
+++ /dev/null
@@ -1,27 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Architecture
-============
-
-.. note::
-   * This section is used to describe a software component from a high level
-     view of capability, common usage scenarios, and interactions with other
-     components required in the usage scenarios.  
-   
-   * The architecture section is typically: provided in a platform-component
-     and sdk collections; and referenced from developer and user guides.
-   
-   * This note must be removed after content has been added.
-
-
-Capabilities
-------------
-
-
-Usage Scenarios
----------------
-
-
-Interactions
-------------
diff --git a/docs/sli/adaptors/build.rst b/docs/sli/adaptors/build.rst
deleted file mode 100644 (file)
index 0a4c308..0000000
+++ /dev/null
@@ -1,18 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Build
-=====
-
-
-Environment
------------
-Requires maven release 3.3 or greater
-
-Steps
------
-To compile this code:
-
-1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the ONAP repositories and OpenDaylight repositories.
-
-2. To compile, run "mvn clean install".
\ No newline at end of file
diff --git a/docs/sli/adaptors/index.rst b/docs/sli/adaptors/index.rst
deleted file mode 100644 (file)
index 3156c8a..0000000
+++ /dev/null
@@ -1,12 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-CCSDK Service Logic Interpretor Adaptors
-----------------------------------------
-.. toctree::
-   :maxdepth: 1
-
-   architecture.rst
-   offeredapis.rst
-   logging.rst
-   build.rst
-   release-notes.rst
diff --git a/docs/sli/adaptors/offeredapis.rst b/docs/sli/adaptors/offeredapis.rst
deleted file mode 100644 (file)
index e20c786..0000000
+++ /dev/null
@@ -1,6 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Offered APIs
-============
-
diff --git a/docs/sli/adaptors/release-notes.rst b/docs/sli/adaptors/release-notes.rst
deleted file mode 100644 (file)
index b451657..0000000
+++ /dev/null
@@ -1,46 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Release Notes
-=============
-
-.. note::
-   * This Release Notes must be updated each time the team decides to Release new artifacts.
-   * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
-   * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
-   * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
-   * This note must be removed after content has been added.
-
-
-Version: x.y.z
---------------
-
-
-:Release Date: yyyy-mm-dd
-
-
-
-**New Features**
-
-One or two sentences explaining the purpose of this Release.
-
-**Bug Fixes**
-   - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
-**Known Issues**
-   - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
-     One sentences explaining what is the issue.
-
-     Another sentence explaining the impact of the issue.
-
-     And an optional sentence providing a workaround.
-
-**Security Issues**
-   You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
-
-
-**Upgrade Notes**
-
-**Deprecation Notes**
-
-**Other**
-
-===========
\ No newline at end of file
diff --git a/docs/sli/architecture.rst b/docs/sli/architecture.rst
new file mode 100644 (file)
index 0000000..a211cc6
--- /dev/null
@@ -0,0 +1,29 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Architecture
+============
+
+Repositories
+------------
+CCSDK contains the following repositories to support service logic (aka directed graph)
+development:
+
+- ccsdk/parent : contains parent poms, which contain common properties, plugin settings, etc
+- ccsdk/sli/core : contains the core components needed to compile and execute directed graphs
+- ccsdk/sli/adaptors : contains adaptors to provide access to resources from within directed graphs
+- ccsdk/sli/northbound : contains code for northbound interfaces that maybe used by CCSDK clients
+- ccsdk/sli/plugins : contains code to be called from directed graph "execute" nodes
+
+Capabilities
+------------
+Provides the core Service Logic Interpreter (SLI) functionality, used to execute directed graphs (DGs).  Directed graphs allow service designers to define the
+logic to be executed within the SDN controller in a graphical format which can be
+updated in real time, without a need to restart the controller.
+
+.. toctree::
+   :maxdepth: 1
+
+   nodes.rst
+
+
diff --git a/docs/sli/build.rst b/docs/sli/build.rst
new file mode 100644 (file)
index 0000000..3d9ccdb
--- /dev/null
@@ -0,0 +1,30 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Build
+=====
+
+
+Environment
+-----------
+Requires maven release 3.3 or greater
+
+Steps
+-----
+To compile this code:
+
+1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the ONAP repositories and OpenDaylight repositories.
+
+2. To compile all of CCSDK SLI code
+    - git clone http://gerrit.onap.org/r/ccsdk/parent
+    - cd parent ; mvn clean install ; cd ..
+    -  mkdir sli ; cd sli
+    - git clone http://gerrit.onap.org/r/ccsdk/sli/core
+    - git clone http://gerrit.onap.org/r/ccsdk/sli/adaptors
+    - git clone http://gerrit.onap.org/r/ccsdk/sli/northbound
+    - git clone http://gerrit.onap.org/r/ccsdk/sli/plugins
+    - cd core ; mvn clean install
+    - cd ../adaptors ; mvn clean install
+    - cd ../northbound ; mvn clean install
+    - cd ../plugins ; mvn clean install
+    
\ No newline at end of file
diff --git a/docs/sli/core/architecture.rst b/docs/sli/core/architecture.rst
deleted file mode 100644 (file)
index f6101a1..0000000
+++ /dev/null
@@ -1,20 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Architecture
-============
-
-
-
-Capabilities
-------------
-Provides the core Service Logic Interpreter (SLI) functionality, used to execute directed graphs (DGs).  Directed graphs allow service designers to define the
-logic to be executed within the SDN controller in a graphical format which can be
-updated in real time, without a need to restart the controller.
-
-.. toctree::
-   :maxdepth: 1
-
-   nodes.rst
-
-
diff --git a/docs/sli/core/build.rst b/docs/sli/core/build.rst
deleted file mode 100644 (file)
index 0a4c308..0000000
+++ /dev/null
@@ -1,18 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Build
-=====
-
-
-Environment
------------
-Requires maven release 3.3 or greater
-
-Steps
------
-To compile this code:
-
-1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the ONAP repositories and OpenDaylight repositories.
-
-2. To compile, run "mvn clean install".
\ No newline at end of file
diff --git a/docs/sli/core/index.rst b/docs/sli/core/index.rst
deleted file mode 100644 (file)
index 2055f17..0000000
+++ /dev/null
@@ -1,13 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-CCSDK Service Logic Interpreter
--------------------------------
-.. toctree::
-   :maxdepth: 1
-
-   architecture.rst
-   offeredapis.rst
-   logging.rst
-   build.rst
-   release-notes.rst
-
diff --git a/docs/sli/core/logging.rst b/docs/sli/core/logging.rst
deleted file mode 100644 (file)
index 187eb03..0000000
+++ /dev/null
@@ -1,14 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Logging
-=======
-CCSDK uses slf4j to log messages to the standard OpenDaylight karaf.log
-log file.
-
-Where to Access Information
----------------------------
-Logs are found within the SDNC docker container, in the directory
-/opt/opendaylight/current/data/logs.
-
-
diff --git a/docs/sli/core/offeredapis.rst b/docs/sli/core/offeredapis.rst
deleted file mode 100644 (file)
index 42eafdd..0000000
+++ /dev/null
@@ -1,12 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Offered APIs
-============
-
-.. toctree::
-   :maxdepth: 1
-   :titlesonly:
-
-   apis/sliapi.rst
-
diff --git a/docs/sli/core/release-notes.rst b/docs/sli/core/release-notes.rst
deleted file mode 100644 (file)
index b451657..0000000
+++ /dev/null
@@ -1,46 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Release Notes
-=============
-
-.. note::
-   * This Release Notes must be updated each time the team decides to Release new artifacts.
-   * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
-   * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
-   * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
-   * This note must be removed after content has been added.
-
-
-Version: x.y.z
---------------
-
-
-:Release Date: yyyy-mm-dd
-
-
-
-**New Features**
-
-One or two sentences explaining the purpose of this Release.
-
-**Bug Fixes**
-   - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
-**Known Issues**
-   - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
-     One sentences explaining what is the issue.
-
-     Another sentence explaining the impact of the issue.
-
-     And an optional sentence providing a workaround.
-
-**Security Issues**
-   You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
-
-
-**Upgrade Notes**
-
-**Deprecation Notes**
-
-**Other**
-
-===========
\ No newline at end of file
similarity index 55%
rename from docs/sli/northbound/index.rst
rename to docs/sli/index.rst
index 9be06c8..7b86458 100644 (file)
@@ -1,13 +1,14 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Directed Graph Support (Service Logic Interpreter)
+==================================================
 
-CCSDK SLI Northbound API
-------------------------
 .. toctree::
    :maxdepth: 1
 
    architecture.rst
-   offeredapis.rst
-   logging.rst
    build.rst
-   release-notes.rst
-
+   logging.rst
+   offeredapis.rst
similarity index 100%
rename from docs/sli/core/nodes.rst
rename to docs/sli/nodes.rst
diff --git a/docs/sli/northbound/architecture.rst b/docs/sli/northbound/architecture.rst
deleted file mode 100644 (file)
index f2648df..0000000
+++ /dev/null
@@ -1,12 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Architecture
-============
-
-
-Capabilities
-------------
-This repository contains source code and Yang models for the northbound interfaces
-used to process updates from SDC (ASDC-API) and for processing data change notifications
-from A&AI (dataChange).
diff --git a/docs/sli/northbound/build.rst b/docs/sli/northbound/build.rst
deleted file mode 100644 (file)
index 0a4c308..0000000
+++ /dev/null
@@ -1,18 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Build
-=====
-
-
-Environment
------------
-Requires maven release 3.3 or greater
-
-Steps
------
-To compile this code:
-
-1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the ONAP repositories and OpenDaylight repositories.
-
-2. To compile, run "mvn clean install".
\ No newline at end of file
diff --git a/docs/sli/northbound/logging.rst b/docs/sli/northbound/logging.rst
deleted file mode 100644 (file)
index 187eb03..0000000
+++ /dev/null
@@ -1,14 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Logging
-=======
-CCSDK uses slf4j to log messages to the standard OpenDaylight karaf.log
-log file.
-
-Where to Access Information
----------------------------
-Logs are found within the SDNC docker container, in the directory
-/opt/opendaylight/current/data/logs.
-
-
diff --git a/docs/sli/northbound/nodes.rst b/docs/sli/northbound/nodes.rst
deleted file mode 100644 (file)
index 3bdeabc..0000000
+++ /dev/null
@@ -1,1031 +0,0 @@
---- Service Logic Interpreter --- Dan Timoney --- 2014-11-12 ---
-
-Supported node types
-====================
-
-The following built-in node types are currently supported:
-
--  Flow Control
-
-   -  `**block** <#Block_node>`__
-
-   -  `**call** <#Call_node>`__
-
-   -  `**for** <#For_node>`__
-
-   -  `**return** <#Return_node>`__
-
-   -  `**set** <#Set_node>`__
-
-   -  `**switch** <#Switch_node>`__
-
--  Device Management
-
-   -  `**configure** <#Configure_node>`__
-
--  Java Plugin Support
-
-   -  `**execute** <#Execute_node>`__
-
--  Recording
-
-   -  `**record** <#Record_node>`__
-
--  Resource Management
-
-   -  `**delete** <#Delete_node>`__
-
-   -  `**exists** <#Exists_node>`__
-
-   -  `**get-resource** <#Get-resource_node>`__
-
-   -  `**is-available** <#Is-available_node>`__
-
-   -  `**notify** <#Notify_node>`__
-
-   -  `**release** <#Release_node>`__
-
-   -  `**reserve** <#Reserve_node>`__
-
-   -  `**save** <#Save_node>`__
-
-   -  `**update** <#Update_node>`__
-
-Flow Control
-------------
-
-Block node
-~~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-A **block** node is used to executes a set of nodes.
-
-Attributes
-^^^^^^^^^^
-
-+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| **atomic**   | if *true*, then if a node returns failure, subsequent nodes will not be executed and nodes already executed will be backed out.   |
-+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-None
-
-Outcomes
-^^^^^^^^
-
-None
-
-Example
-^^^^^^^
-
-::
-
-    <block>
-      <record plugin="org.onap.ccsdk.sli.core.sli.recording.FileRecorder">
-        <parameter name="file" value="/tmp/sample_r1.log" />
-        <parameter name="field1" value="__TIMESTAMP__"/>
-        <parameter name="field2" value="RESERVED"/>
-        <parameter name="field3" value="$asePort.uni_circuit_id"/>
-      </record>
-      <return status="success">
-        <parameter name="uni-circuit-id" value="$asePort.uni_circuit_id" />
-      </return>
-    </block>
-
-Call node
-~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-A **call** node is used to call another graph
-
-Attributes
-^^^^^^^^^^
-
-+---------------+------------------------------------------------------------------------------------+
-| **module**    | Module of directed graph to call. If unset, defaults to that of calling graph      |
-+---------------+------------------------------------------------------------------------------------+
-| **rpc**       | rpc of directed graph to call.                                                     |
-+---------------+------------------------------------------------------------------------------------+
-| **version**   | version of graph to call, If unset, uses active version.                           |
-+---------------+------------------------------------------------------------------------------------+
-| **mode**      | mode (sync/async) of graph to call. If unset, defaults to that of calling graph.   |
-+---------------+------------------------------------------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-Not applicable
-
-Outcomes
-^^^^^^^^
-
-+-----------------+------------------------------+
-| **success**     | Sub graph returned success   |
-+-----------------+------------------------------+
-| **not-found**   | Graph not found              |
-+-----------------+------------------------------+
-| **failure**     | Subgraph returned success    |
-+-----------------+------------------------------+
-
-Table: .
-
-Example
-^^^^^^^
-
-::
-
-    <call rpc="svc-topology-reserve" mode="sync" />
-
-For node
-~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-A **for** node provides a fixed iteration looping mechanism, similar to
-the Java for loop
-
-Attributes
-^^^^^^^^^^
-
-+-------------+------------------+
-| **index**   | index variable   |
-+-------------+------------------+
-| **start**   | initial value    |
-+-------------+------------------+
-| **end**     | maximum value    |
-+-------------+------------------+
-
-Parameters
-^^^^^^^^^^
-
-Not applicable.
-
-Outcomes
-^^^^^^^^
-
-Not applicable. The **status** node has no outcomes.
-
-Example
-^^^^^^^
-
-::
-
-    <for index="i" start="0" end="`$service-data.universal-cpe-ft.l2-switch-interfaces_length`">
-       <record plugin="org.onap.ccsdk.sli.core.sli.recording.Slf4jRecorder">
-          <parameter name="logger" value="message-log"/>
-          <parameter name="level" value="info"/>
-          <parameter name="field1" value="`'current l2-switch-interface name is ' + $service-data.universal-cpe-ft.l2-switch-interfaces[$i].name`"/>
-       </record>
-    </for>
-
-Return node
-~~~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-A **return** node is used to return a status to the invoking MD-SAL
-application
-
-Attributes
-^^^^^^^^^^
-
-+--------------+---------------------------------------------------+
-| **status**   | Status value to return (*success* or *failure*)   |
-+--------------+---------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-The following optional parameters may be passed to convey more detailed
-status information.
-
-+---------------------+-----------------------------------------------------------------+
-| **error-code**      | A brief, usually numeric, code indicating the error condition   |
-+---------------------+-----------------------------------------------------------------+
-| **error-message**   | A more detailed error message                                   |
-+---------------------+-----------------------------------------------------------------+
-
-Outcomes
-^^^^^^^^
-
-Not applicable. The **status** node has no outcomes.
-
-Example
-^^^^^^^
-
-::
-
-    <return status="failure">
-      <parameter name="error-code" value="1542" />
-      <parameter name="error-message" value="Activation failure" />
-    </return>
-
-Set node
-~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-A **set** node is used to set one or more values in the execution
-context
-
-Attributes
-^^^^^^^^^^
-
-+---------------------+-------------------------------------------------------------------------------------+
-| **only-if-unset**   | If true the set node will only execute if the current value of the target is null   |
-+---------------------+-------------------------------------------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-Values to be set are passed as parameters
-
-Outcomes
-^^^^^^^^
-
-Not applicable. The **set** node has no outcomes.
-
-Example
-^^^^^^^
-
-::
-
-    <set>
-      <parameter name="vlan" value="$network.provider-segmentation-id" />
-    </set>
-
-Switch node
-~~~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-A **switch** node is used to make a decision based on its **test**
-attribute.
-
-Attributes
-^^^^^^^^^^
-
-+------------+---------------------+
-| **test**   | Condition to test   |
-+------------+---------------------+
-
-Parameters
-^^^^^^^^^^
-
-None
-
-Outcomes
-^^^^^^^^
-
-Depends on the **test** condition
-
-Example
-^^^^^^^
-
-::
-
-    <switch test="$uni-cir-units">
-      <outcome value="Mbps">
-        <reserve plugin="org.onap.ccsdk.sli.adaptors.samplesvc.SampleServiceResource"
-                 resource="ase-port"
-                 key="resource-emt-clli == $edge-device-clli and speed >= $uni-cir-value"
-                 pfx="asePort">
-
-          <outcome value="success">
-            <return status="success">
-              <parameter name="uni-circuit-id" value="$asePort.uni_circuit_id" />
-            </return>
-          </outcome>
-          <outcome value="Other">
-            <return status="failure">
-              <parameter name="error-code" value="1010" />
-              <parameter name="error-message" value="No ports found that match criteria" />
-            </return>
-          </outcome>
-        </reserve>
-      </outcome>
-      <outcome value="Gbps">
-        <reserve plugin="org.onap.ccsdk.sli.adaptors.samplesvc.SampleServiceResource"
-                 resource="ase-port"
-                 key="resource-emt-clli == $edge-device-clli and speed >= $uni-cir-value*1000"
-                 pfx="asePort">
-
-          <outcome value="success">
-            <return status="success">
-              <parameter name="uni-circuit-id" value="$asePort.uni_circuit_id" />
-            </return>
-          </outcome>
-          <outcome value="Other">
-            <return status="failure">
-              <parameter name="error-code" value="1010" />
-              <parameter name="error-message" value="No ports found that match criteria" />
-            </return>
-          </outcome>
-        </reserve>
-      </outcome>
-    </switch>
-
-Device Management
------------------
-
-Configure node
-~~~~~~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-A **configure** node is used to configure a device.
-
-Attributes
-^^^^^^^^^^
-
-+----------------+-----------------------------------------------------------------------------------+
-| **adaptor**    | Fully qualified Java class of resource adaptor to be used                         |
-+----------------+-----------------------------------------------------------------------------------+
-| **activate**   | Activate device/interface, for devices that support a separate activation step.   |
-+----------------+-----------------------------------------------------------------------------------+
-| **key**        | SQL-like string specifying criteria for item to configure                         |
-+----------------+-----------------------------------------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-Specific to device adaptor.
-
-Outcomes
-^^^^^^^^
-
-+----------------------+------------------------------------------------------------------+
-| **success**          | Device successfully configured                                   |
-+----------------------+------------------------------------------------------------------+
-| **not-found**        | Element to be configured does not exist.                         |
-+----------------------+------------------------------------------------------------------+
-| **not-ready**        | Element is not in a state where it can be configured/activated   |
-+----------------------+------------------------------------------------------------------+
-| **already-active**   | Attempt to activate element that is already active               |
-+----------------------+------------------------------------------------------------------+
-| **failure**          | Configure failed for some other reason                           |
-+----------------------+------------------------------------------------------------------+
-
-Example
-^^^^^^^
-
-::
-
-    <configure adaptor="org.onap.ccsdk.sli.adaptors.emt.EmtAdaptor"
-               key="$uni-circuit-id" activate="true">
-      <parameter name="circuit.id" value="$uni-circuit-id" />
-      <parameter name="subscriber.name" value="$subscriber-name" />
-      <parameter name="emt.clli" value="$edge-device-clli" />
-      <parameter name="port.tagging" value="$port-tagging" />
-      <parameter name="port.mediaSpeed" value="$media-speed" />
-      <parameter name="location.state" value="$uni-location-state" />
-      <parameter name="location.city" value="$uni-location-city" />
-      <parameter name="cosCategory" value="$cos-category" />
-      <parameter name="gosProfile" value="$gos-profile" />
-      <parameter name="lldp" value="$asePort.resource-lldp" />
-      <parameter name="mtu" value="$asePort.resource-mtu" />
-      <outcome value="success">
-        <block>
-          <record plugin="org.onap.ccsdk.sli.core.sli.recording.FileRecorder">
-            <parameter name="file" value="/tmp/sample_r1.log" />
-            <parameter name="field1" value="__TIMESTAMP__"/>
-            <parameter name="field2" value="ACTIVE"/>
-            <parameter name="field3" value="$uni-circuit-id"/>
-          </record>
-          <return status="success">
-            <parameter name="edge-device-clli" value="$asePort.resource-emt-clli" />
-          </return>
-        </block>
-      </outcome>
-      <outcome value="already-active">
-        <return status="failure">
-          <parameter name="error-code" value="1590" />
-          <parameter name="error-message" value="Port already active" />
-        </return>
-      </outcome>
-      <outcome value="Other">
-        <return status="failure">
-          <parameter name="error-code" value="1542" />
-          <parameter name="error-message" value="Activation failure" />
-        </return>
-      </outcome>
-    </configure>
-
-Java Plugin Support
--------------------
-
-Execute node
-~~~~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-An **execute** node is used to execute Java code supplied as a plugin
-
-Attributes
-^^^^^^^^^^
-
-+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| **plugin**   | Fully qualified Java class of plugin to be used                                                                                                                                                    |
-+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| **method**   | Name of method in the plugin class to execute. Method must return void, and take 2 arguments: a Map (for parameters) and a SvcLogicContext (to allow plugin read/write access to context memory)   |
-+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-Specific to plugin / method
-
-Outcomes
-^^^^^^^^
-
-+--------------------------+-----------------------------------------------------------------+
-| **success**              | Device successfully configured                                  |
-+--------------------------+-----------------------------------------------------------------+
-| **not-found**            | Plugin class could not be loaded                                |
-+--------------------------+-----------------------------------------------------------------+
-| **unsupported-method**   | Named method taking (Map, SvcLogicContext) could not be found   |
-+--------------------------+-----------------------------------------------------------------+
-| **failure**              | Configure failed for some other reason                          |
-+--------------------------+-----------------------------------------------------------------+
-
-Example
-^^^^^^^
-
-::
-
-    <execute plugin="org.onap.ccsdk.sli.plugins.HelloWorld"
-               method="log">
-      <parameter name="message" value="Hello, world!" />
-      <outcome value="success">
-          <return status="success"/>
-      </outcome>
-      <outcome value="not-found">
-        <return status="failure">
-          <parameter name="error-code" value="1590" />
-          <parameter name="error-message" value="Could not locate plugin" />
-        </return>
-      </outcome>
-      <outcome value="Other">
-        <return status="failure">
-          <parameter name="error-code" value="1542" />
-          <parameter name="error-message" value="Internal error" />
-        </return>
-      </outcome>
-    </execute>
-
-Recording
----------
-
-Record node
-~~~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-A **record** node is used to record an event. For example, this might be
-used to log provisioning events.
-
-Attributes
-^^^^^^^^^^
-
-+--------------+---------------------------------------------------+
-| **plugin**   | Fully qualified Java class to handle recording.   |
-+--------------+---------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-Parameters will depend on the plugin being used. For the FileRecorder
-class, the parameters are as follows
-
-+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| **file**     | The file to which the record should be written                                                                                                                                                                       |
-+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| **field1**   | First field to write. There will be **field** parameters for each field to write, from **field1** through **fieldN**. A special value \_\_TIMESTAMP\_\_ may be assigned to a field to insert the current timestamp   |
-+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Outcomes
-^^^^^^^^
-
-+---------------+--------------------------------------------+
-| **success**   | Record successfully written                |
-+---------------+--------------------------------------------+
-| **failure**   | Record could not be successfully written   |
-+---------------+--------------------------------------------+
-
-Example
-^^^^^^^
-
-::
-
-    <record plugin="org.onap.ccsdk.sli.core.sli.recording.FileRecorder">
-      <parameter name="file" value="/tmp/sample_r1.log" />
-      <parameter name="field1" value="__TIMESTAMP__"/>
-      <parameter name="field2" value="ACTIVE"/>
-      <parameter name="field3" value="$uni-circuit-id"/>
-    </record>
-
-Resource Management
--------------------
-
-Delete node
-~~~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-A **delete** node is used to delete a resource from the local resource
-inventory.
-
-Attributes
-^^^^^^^^^^
-
-+----------------+-------------------------------------------------------------+
-| **plugin**     | Fully qualified Java class of resource adaptor to be used   |
-+----------------+-------------------------------------------------------------+
-| **resource**   | Type of resource to delete                                  |
-+----------------+-------------------------------------------------------------+
-| **key**        | SQL-like string specifying key to delete                    |
-+----------------+-------------------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-None
-
-Outcomes
-^^^^^^^^
-
-+---------------+--------------------------------------------+
-| **success**   | Resource specified deleted successfully.   |
-+---------------+--------------------------------------------+
-| *failure*>    | Resource specified was not deleted         |
-+---------------+--------------------------------------------+
-
-Example
-^^^^^^^
-
-::
-
-    <delete plugin="org.onap.ccsdk.sli.adaptors.samplesvc.SampleServiceResource"
-            resource="ase-port"
-            key="uni_circuit_id == $uni-circuit-id">
-      <outcome value="true">
-        <return status="success"/>
-      </outcome>
-      <outcome value="false">
-        <return status="failure"/>
-      </outcome>
-    </delete>
-
-Exists node
-~~~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-An **exists** node is used to determine whether a particular instance of
-a resource exists. For example, this might be used to test whether a
-particular switch CLLI is provisioned.
-
-Attributes
-^^^^^^^^^^
-
-+----------------+-------------------------------------------------------------+
-| **plugin**     | Fully qualified Java class of resource adaptor to be used   |
-+----------------+-------------------------------------------------------------+
-| **resource**   | Type of resource to check                                   |
-+----------------+-------------------------------------------------------------+
-| **key**        | SQL-like string specifying key to check for                 |
-+----------------+-------------------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-None
-
-Outcomes
-^^^^^^^^
-
-+-------------+---------------------------------+
-| **true**    | Resource specified exists.      |
-+-------------+---------------------------------+
-| **false**   | Resource specified is unknown   |
-+-------------+---------------------------------+
-
-Example
-^^^^^^^
-
-::
-
-    <exists plugin="org.onap.ccsdk.sli.adaptors.samplesvc.SampleServiceResource"
-            resource="ase-port"
-            key="uni_circuit_id == $uni-circuit-id">
-      <outcome value="true">
-        <return status="success"/>
-      </outcome>
-      <outcome value="false">
-        <return status="failure"/>
-      </outcome>
-    </exists>
-
-Get-resource node
-~~~~~~~~~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-A **get-resource** node is used to retrieve information about a
-particular resource and make it available to other nodes in the service
-logic tree. For example, this might be used to retrieve information
-about a particular uni-port.
-
-Attributes
-^^^^^^^^^^
-
-+----------------+------------------------------------------------------------------------------------------+
-| **plugin**     | Fully qualified Java class of resource adaptor to be used                                |
-+----------------+------------------------------------------------------------------------------------------+
-| **resource**   | Type of resource to retrieve                                                             |
-+----------------+------------------------------------------------------------------------------------------+
-| **key**        | SQL-like string specifying criteria for retrieval                                        |
-+----------------+------------------------------------------------------------------------------------------+
-| **pfx**        | Prefix to add to context variable names set for data retrieved                           |
-+----------------+------------------------------------------------------------------------------------------+
-| **select**     | String to specify, if key matches multiple entries, which entry should take precedence   |
-+----------------+------------------------------------------------------------------------------------------+
-| **order-by**   | Prefix to add to context variable names set for data retrieved                           |
-+----------------+------------------------------------------------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-None
-
-Outcomes
-^^^^^^^^
-
-+-----------------+--------------------------------------------------+
-| **success**     | Resource successfully retrieved                  |
-+-----------------+--------------------------------------------------+
-| **not-found**   | Resource referenced does not exist               |
-+-----------------+--------------------------------------------------+
-| **failure**     | Resource retrieve failed for some other reason   |
-+-----------------+--------------------------------------------------+
-
-Example
-^^^^^^^
-
-::
-
-    <get-resource plugin="org.onap.ccsdk.sli.adaptors.samplesvc.SampleServiceResource"
-                  resource="ase-port"
-                  key="uni_circuit_id == $uni-circuit-id"
-                  pfx="current-port">
-      <outcome value="success">
-        <return status="success"/>
-      </outcome>
-      <outcome value="not-found">
-        <return status="failure"/>
-      </outcome>
-      <outcome value="failure">
-        <return status="failure"/>
-      </outcome>
-    </get-resource>
-
-Is-available node
-~~~~~~~~~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-An **is-available** node is used to determine whether a particular type
-of resource is available. For example, this might be used to test
-whether any ports are available for assignment on a particular switch.
-
-Attributes
-^^^^^^^^^^
-
-+----------------+------------------------------------------------------------------+
-| **plugin**     | Fully qualified Java class of resource adaptor to be used        |
-+----------------+------------------------------------------------------------------+
-| **resource**   | Type of resource to check                                        |
-+----------------+------------------------------------------------------------------+
-| **key**        | SQL-like string specifying key to check for                      |
-+----------------+------------------------------------------------------------------+
-| **pfx**        | Prefix to add to context variable names set for data retrieved   |
-+----------------+------------------------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-None
-
-Outcomes
-^^^^^^^^
-
-+-------------+---------------------------------------+
-| **true**    | Resource requested is available       |
-+-------------+---------------------------------------+
-| **false**   | Resource requested is not available   |
-+-------------+---------------------------------------+
-
-Example
-^^^^^^^
-
-::
-
-    <is-available plugin="org.onap.ccsdk.sli.adaptors.samplesvc.SampleServiceResource"
-                  resource="ase-port"
-                  key="resource-emt-clli == $edge-device-clli and speed >= $uni-cir-value">
-      <outcome value="true">
-        <return status="success"/>
-      </outcome>
-      <outcome value="false">
-        <return status="failure"/>
-      </outcome>
-    </is-available>
-
-Notify node
-~~~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-A **notify** node is used to inform an external application (e.g. A&AI)
-that a resource was updated.
-
-Attributes
-^^^^^^^^^^
-
-+----------------+---------------------------------------------------------------------+
-| **plugin**     | Fully qualified Java class of resource adaptor to be used           |
-+----------------+---------------------------------------------------------------------+
-| **resource**   | Identifies resource that was updated                                |
-+----------------+---------------------------------------------------------------------+
-| **action**     | Action that triggered notification to be sent (ADD/UPDATE/DELETE)   |
-+----------------+---------------------------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-None
-
-Outcomes
-^^^^^^^^
-
-+---------------+----------------------------------------+
-| **success**   | Notification was successful            |
-+---------------+----------------------------------------+
-| **failure**   | Notification failed is not available   |
-+---------------+----------------------------------------+
-
-Example
-^^^^^^^
-
-::
-
-    <notify plugin="org.onap.ccsdk.sli.adaptors.samplesvc.SampleServiceResource"
-                  resource="ase-port"
-                  action="ADD">
-      <outcome value="success">
-        <return status="success"/>
-      </outcome>
-      <outcome value="Other">
-        <return status="failure"/>
-      </outcome>
-    </notify>
-
-Release node
-~~~~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-A **release** node is used to mark a resource as no longer in use, and
-thus available for assignment.
-
-Attributes
-^^^^^^^^^^
-
-+----------------+------------------------------------------------------------------+
-| **plugin**     | Fully qualified Java class of resource adaptor to be used        |
-+----------------+------------------------------------------------------------------+
-| **resource**   | Type of resource to release                                      |
-+----------------+------------------------------------------------------------------+
-| **key**        | SQL-like string specifying key to check of resource to release   |
-+----------------+------------------------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-None
-
-Outcomes
-^^^^^^^^
-
-+-----------------+-------------------------------------------------+
-| **success**     | Resource successfully released                  |
-+-----------------+-------------------------------------------------+
-| **not-found**   | Resource referenced does not exist              |
-+-----------------+-------------------------------------------------+
-| **failure**     | Resource release failed for some other reason   |
-+-----------------+-------------------------------------------------+
-
-Example
-^^^^^^^
-
-::
-
-    <release plugin="org.onap.ccsdk.sli.adaptors.SampleServiceResource"
-             resource="ase-port"
-             key="uni_circuit_id == $uni-circuit-id">
-      <outcome value="success">
-        <return status="success"/>
-      </outcome>
-      <outcome value="not-found">
-        <return status="failure"/>
-      </outcome>
-      <outcome value="failure">
-        <return status="failure"/>
-      </outcome>
-    </release>
-
-Reserve node
-~~~~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-A **reserve** node is used to reserve a particular type of resource..
-For example, this might be used to reserve a port on a particular
-switch.
-
-Attributes
-^^^^^^^^^^
-
-+----------------+----------------------------------------------------------------------------------------------+
-| **plugin**     | Fully qualified Java class of resource adaptor to be used                                    |
-+----------------+----------------------------------------------------------------------------------------------+
-| **resource**   | Type of resource to reserve                                                                  |
-+----------------+----------------------------------------------------------------------------------------------+
-| **key**        | SQL-like string specifying criteria for reservation                                          |
-+----------------+----------------------------------------------------------------------------------------------+
-| **select**     | String to specify, if **key** matches multiple entries, which entry should take precedence   |
-+----------------+----------------------------------------------------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-None
-
-Outcomes
-^^^^^^^^
-
-+---------------+----------------------------------------------------+
-| **success**   | Resource requested was successfully reserved       |
-+---------------+----------------------------------------------------+
-| **failure**   | Resource requested was not successfully reserved   |
-+---------------+----------------------------------------------------+
-
-Example
-^^^^^^^
-
-::
-
-    <reserve plugin="org.onap.ccsdk.sli.adaptors.samplesvc.SampleServiceResource"
-             resource="ase-port"
-             key="resource-emt-clli == $edge-device-clli and speed >= $uni-cir-value"
-             select="min(speed)">
-      <outcome value="success">
-        <return status="success"/>
-      </outcome>
-      <outcome value="failure">
-        <return status="failure"/>
-      </outcome>
-    </reserve>
-
-Save node
-~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-A **save** node is used to save information about a particular resource
-to persistent storage. For example, this might be used to save
-information about a particular uni-port.
-
-Attributes
-^^^^^^^^^^
-
-+----------------+------------------------------------------------------------------------------------------+
-| **plugin**     | Fully qualified Java class of resource adaptor to be used                                |
-+----------------+------------------------------------------------------------------------------------------+
-| **resource**   | Type of resource to save                                                                 |
-+----------------+------------------------------------------------------------------------------------------+
-| **key**        | SQL-like string specifying criteria for retrieval                                        |
-+----------------+------------------------------------------------------------------------------------------+
-| **force**      | If "true", save resource even if this resource is already stored in persistent storage   |
-+----------------+------------------------------------------------------------------------------------------+
-| **pfx**        | Prefix to be prepended to variable names, when attributes are set in SvcLogicContext     |
-+----------------+------------------------------------------------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-Values to save (columns) are specified as parameters, with each name
-corresponding to a column name and each value corresponding to the value
-to set.
-
-Outcomes
-^^^^^^^^
-
-+---------------+-------------------------------+
-| **success**   | Resource successfully saved   |
-+---------------+-------------------------------+
-| **failure**   | Resource save failed          |
-+---------------+-------------------------------+
-
-Example
-^^^^^^^
-
-::
-
-    <save plugin="`$sample-resource-plugin`" resource="vnf"
-        key="vnf-name = $requests.vnf.vnf-name" force="true"
-        pfx="requests.vnf">
-        <parameter name="vnf-name"
-            value="`$requests.cust-country-code + $requests.cust-id + $requests.cust-city + $requests.cust-state + '001VCE'`" />
-        <parameter name="vnf-type" value="vce" />
-        <parameter name="orchestration-status" value="pending-create" />
-        <parameter name="heat-stack-id" value="`$requests.heat-stack-id`" />
-        <parameter name="mso-catalog-key" value="`$requests.mso-catalog-key`" />
-        <parameter name="oam-ipv4-address" value="`$vce-ipv4-oam-addr.ipv4-addr`" />
-    </save>
-
-Update node
-~~~~~~~~~~~
-
-Description
-^^^^^^^^^^^
-
-An **update** node is used to update information about a particular
-resource to persistent storage.
-
-Attributes
-^^^^^^^^^^
-
-+----------------+----------------------------------------------------------------------------------------+
-| **plugin**     | Fully qualified Java class of resource adaptor to be used                              |
-+----------------+----------------------------------------------------------------------------------------+
-| **resource**   | Type of resource to update                                                             |
-+----------------+----------------------------------------------------------------------------------------+
-| **key**        | SQL-like string specifying criteria for retrieval                                      |
-+----------------+----------------------------------------------------------------------------------------+
-| **pfx**        | Prefix to be prepended to variable names, when attributes are set in SvcLogicContext   |
-+----------------+----------------------------------------------------------------------------------------+
-
-Parameters
-^^^^^^^^^^
-
-Values to save (columns) are specified as parameters, with each name
-corresponding to a column name and each value corresponding to the value
-to set.
-
-Outcomes
-^^^^^^^^
-
-+---------------+-------------------------------+
-| **success**   | Resource successfully saved   |
-+---------------+-------------------------------+
-| **failure**   | Resource save failed          |
-+---------------+-------------------------------+
-
-Example
-^^^^^^^
-
-::
-
-    <update plugin="`$sample-resource-plugin`" resource="vnf"
-        key="vnf-name = $requests.vnf.vnf-name"
-        pfx="requests.vnf">
-        <parameter name="vnf-name"
-            value="`$requests.cust-country-code + $requests.cust-id + $requests.cust-city + $requests.cust-state + '001VCE'`" />
-        <parameter name="vnf-type" value="vce" />
-        <parameter name="orchestration-status" value="pending-create" />
-        <parameter name="heat-stack-id" value="`$requests.heat-stack-id`" />
-        <parameter name="mso-catalog-key" value="`$requests.mso-catalog-key`" />
-        <parameter name="oam-ipv4-address" value="`$vce-ipv4-oam-addr.ipv4-addr`" />
-    </update>
diff --git a/docs/sli/northbound/release-notes.rst b/docs/sli/northbound/release-notes.rst
deleted file mode 100644 (file)
index 21ff338..0000000
+++ /dev/null
@@ -1,45 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Release Notes
-=============
-
-.. note::
-   * This Release Notes must be updated each time the team decides to Release new artifacts.
-   * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
-   * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
-   * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
-   * This note must be removed after content has been added.
-
-
-Version: x.y.z
---------------
-
-
-:Release Date: yyyy-mm-dd
-
-
-
-**New Features**
-
-One or two sentences explaining the purpose of this Release.
-
-**Bug Fixes**
-   - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
-**Known Issues**
-   - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
-     One sentences explaining what is the issue.
-
-     Another sentence explaining the impact of the issue.
-
-     And an optional sentence providing a workaround.
-
-**Security Issues**
-   You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
-
-
-**Upgrade Notes**
-
-**Deprecation Notes**
-
-**Other**
-
similarity index 91%
rename from docs/sli/northbound/offeredapis.rst
rename to docs/sli/offeredapis.rst
index 2eebdec..7a75245 100644 (file)
@@ -10,4 +10,6 @@ Offered APIs
 
    apis/asdcApi.rst
    apis/dataChange.rst
+   apis/sliapi.rst
+   
 
diff --git a/docs/sli/plugins/architecture.rst b/docs/sli/plugins/architecture.rst
deleted file mode 100644 (file)
index 8daa0d3..0000000
+++ /dev/null
@@ -1,27 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Architecture
-============
-
-.. note::
-   * This section is used to describe a software component from a high level
-     view of capability, common usage scenarios, and interactions with other
-     components required in the usage scenarios.  
-   
-   * The architecture section is typically: provided in a platform-component
-     and sdk collections; and referenced from developer and user guides.
-   
-   * This note must be removed after content has been added.
-
-
-Capabilities
-------------
-
-
-Usage Scenarios
----------------
-
-
-Interactions
-------------
diff --git a/docs/sli/plugins/build.rst b/docs/sli/plugins/build.rst
deleted file mode 100644 (file)
index 0a4c308..0000000
+++ /dev/null
@@ -1,18 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Build
-=====
-
-
-Environment
------------
-Requires maven release 3.3 or greater
-
-Steps
------
-To compile this code:
-
-1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the ONAP repositories and OpenDaylight repositories.
-
-2. To compile, run "mvn clean install".
\ No newline at end of file
diff --git a/docs/sli/plugins/docs/architecture.rst b/docs/sli/plugins/docs/architecture.rst
deleted file mode 100644 (file)
index 8daa0d3..0000000
+++ /dev/null
@@ -1,27 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Architecture
-============
-
-.. note::
-   * This section is used to describe a software component from a high level
-     view of capability, common usage scenarios, and interactions with other
-     components required in the usage scenarios.  
-   
-   * The architecture section is typically: provided in a platform-component
-     and sdk collections; and referenced from developer and user guides.
-   
-   * This note must be removed after content has been added.
-
-
-Capabilities
-------------
-
-
-Usage Scenarios
----------------
-
-
-Interactions
-------------
diff --git a/docs/sli/plugins/docs/build.rst b/docs/sli/plugins/docs/build.rst
deleted file mode 100644 (file)
index 0a4c308..0000000
+++ /dev/null
@@ -1,18 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Build
-=====
-
-
-Environment
------------
-Requires maven release 3.3 or greater
-
-Steps
------
-To compile this code:
-
-1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the ONAP repositories and OpenDaylight repositories.
-
-2. To compile, run "mvn clean install".
\ No newline at end of file
diff --git a/docs/sli/plugins/docs/index.rst b/docs/sli/plugins/docs/index.rst
deleted file mode 100644 (file)
index 83bb78a..0000000
+++ /dev/null
@@ -1,12 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-CCSDK Service Logic Interpretor Plugins
-----------------------------------------
-.. toctree::
-   :maxdepth: 1
-
-   architecture.rst
-   offeredapis.rst
-   logging.rst
-   build.rst
-   release-notes.rst
diff --git a/docs/sli/plugins/docs/logging.rst b/docs/sli/plugins/docs/logging.rst
deleted file mode 100644 (file)
index 187eb03..0000000
+++ /dev/null
@@ -1,14 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Logging
-=======
-CCSDK uses slf4j to log messages to the standard OpenDaylight karaf.log
-log file.
-
-Where to Access Information
----------------------------
-Logs are found within the SDNC docker container, in the directory
-/opt/opendaylight/current/data/logs.
-
-
diff --git a/docs/sli/plugins/docs/offeredapis.rst b/docs/sli/plugins/docs/offeredapis.rst
deleted file mode 100644 (file)
index e20c786..0000000
+++ /dev/null
@@ -1,6 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Offered APIs
-============
-
diff --git a/docs/sli/plugins/docs/release-notes.rst b/docs/sli/plugins/docs/release-notes.rst
deleted file mode 100644 (file)
index b451657..0000000
+++ /dev/null
@@ -1,46 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Release Notes
-=============
-
-.. note::
-   * This Release Notes must be updated each time the team decides to Release new artifacts.
-   * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
-   * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
-   * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
-   * This note must be removed after content has been added.
-
-
-Version: x.y.z
---------------
-
-
-:Release Date: yyyy-mm-dd
-
-
-
-**New Features**
-
-One or two sentences explaining the purpose of this Release.
-
-**Bug Fixes**
-   - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
-**Known Issues**
-   - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
-     One sentences explaining what is the issue.
-
-     Another sentence explaining the impact of the issue.
-
-     And an optional sentence providing a workaround.
-
-**Security Issues**
-   You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
-
-
-**Upgrade Notes**
-
-**Deprecation Notes**
-
-**Other**
-
-===========
\ No newline at end of file
diff --git a/docs/sli/plugins/index.rst b/docs/sli/plugins/index.rst
deleted file mode 100644 (file)
index 83bb78a..0000000
+++ /dev/null
@@ -1,12 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-CCSDK Service Logic Interpretor Plugins
-----------------------------------------
-.. toctree::
-   :maxdepth: 1
-
-   architecture.rst
-   offeredapis.rst
-   logging.rst
-   build.rst
-   release-notes.rst
diff --git a/docs/sli/plugins/logging.rst b/docs/sli/plugins/logging.rst
deleted file mode 100644 (file)
index 187eb03..0000000
+++ /dev/null
@@ -1,14 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Logging
-=======
-CCSDK uses slf4j to log messages to the standard OpenDaylight karaf.log
-log file.
-
-Where to Access Information
----------------------------
-Logs are found within the SDNC docker container, in the directory
-/opt/opendaylight/current/data/logs.
-
-
diff --git a/docs/sli/plugins/offeredapis.rst b/docs/sli/plugins/offeredapis.rst
deleted file mode 100644 (file)
index e20c786..0000000
+++ /dev/null
@@ -1,6 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Offered APIs
-============
-
diff --git a/docs/sli/plugins/release-notes.rst b/docs/sli/plugins/release-notes.rst
deleted file mode 100644 (file)
index b451657..0000000
+++ /dev/null
@@ -1,46 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Release Notes
-=============
-
-.. note::
-   * This Release Notes must be updated each time the team decides to Release new artifacts.
-   * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
-   * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
-   * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
-   * This note must be removed after content has been added.
-
-
-Version: x.y.z
---------------
-
-
-:Release Date: yyyy-mm-dd
-
-
-
-**New Features**
-
-One or two sentences explaining the purpose of this Release.
-
-**Bug Fixes**
-   - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
-**Known Issues**
-   - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
-     One sentences explaining what is the issue.
-
-     Another sentence explaining the impact of the issue.
-
-     And an optional sentence providing a workaround.
-
-**Security Issues**
-   You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
-
-
-**Upgrade Notes**
-
-**Deprecation Notes**
-
-**Other**
-
-===========
\ No newline at end of file

© 2017 ONAP. Copyright © The Linux Foundation ®. All Rights Reserved.
The Linux Foundation has registered trademarks and uses trademarks.
For a list of trademarks of The Linux Foundation, please see our Trademark Usage page.
Linux is a registered trademark of Linus Torvalds.
Privacy Policy and Terms of Use