summaryrefslogtreecommitdiffstats
path: root/docs/sli/architecture.rst
diff options
context:
space:
mode:
authorTimoney, Dan (dt5972) <dt5972@att.com>2018-06-13 11:11:29 -0400
committerTimoney, Dan (dt5972) <dt5972@att.com>2018-06-13 11:11:29 -0400
commit056e82aa242f7df59c72dc967f38d479c51f7509 (patch)
tree3131114c65277c3d991feed0e82e60909caeac84 /docs/sli/architecture.rst
parent85947fd27e2c0cee9cbc237cfd2c8a440b913832 (diff)
Restructure CCSDK documentation
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>
Diffstat (limited to 'docs/sli/architecture.rst')
-rw-r--r--docs/sli/architecture.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/sli/architecture.rst b/docs/sli/architecture.rst
new file mode 100644
index 00000000..a211cc6f
--- /dev/null
+++ b/docs/sli/architecture.rst
@@ -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
+
+