aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/architecture.rst38
-rw-r--r--docs/images/High_Level_Architecture_SDC.pngbin0 -> 30120 bytes
-rw-r--r--docs/images/SDC_In_ONAP.pngbin0 -> 66297 bytes
3 files changed, 35 insertions, 3 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst
index 8daa0d3bc5..4e20a3e1d0 100644
--- a/docs/architecture.rst
+++ b/docs/architecture.rst
@@ -1,6 +1,7 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+============
Architecture
============
@@ -14,14 +15,45 @@ Architecture
* This note must be removed after content has been added.
+SDC As Part of ONAP
+===================
+
+.. image:: images/SDC_In_ONAP.png
+
+
+High Level Architecture
+=======================
+
+The following diagram shows the high-level relationship between the system components:
+
+.. image:: images/High_Level_Architecture_SDC.png
+
+The SDC architecture uses the Jetty server as an application server.
+
+- The *Jetty front end*:
+ - supplies the static content of web pages, and all resources that required by the GUI
+ - serves as a proxy for the REST API requests coming from the GUI
+
+ Every request originating from the GUI is passed to the Jetty front-end server before it is executed.
+
+- The *Jetty back end* containes all the logic for the SDC.
+
+SDC uses two storage components: Elastic Search(ES) and Cassandra
+
+- *Elastic Search* is used to index the auditing data received from different operations in the SDC.
+
+ This information can then be analyzed with Kibana. The *Kibana server* enables statistical analysis of the operations done, according to the business logic.
+
+- *Cassandra* is used to store auditing data, artifacts and data model objects.
+
Capabilities
-------------
+============
Usage Scenarios
----------------
+===============
Interactions
-------------
+============
diff --git a/docs/images/High_Level_Architecture_SDC.png b/docs/images/High_Level_Architecture_SDC.png
new file mode 100644
index 0000000000..57a564b8d0
--- /dev/null
+++ b/docs/images/High_Level_Architecture_SDC.png
Binary files differ
diff --git a/docs/images/SDC_In_ONAP.png b/docs/images/SDC_In_ONAP.png
new file mode 100644
index 0000000000..ddca06490d
--- /dev/null
+++ b/docs/images/SDC_In_ONAP.png
Binary files differ
Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ~ Copyright © 2016-2018 European Support Limited
  ~
  ~ 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/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>org.openecomp.sdc</groupId>
    <artifactId>backend</artifactId>
    <version>1.9.5-SNAPSHOT</version>
  </parent>

  <artifactId>openecomp-sdc-healthcheck-manager</artifactId>

  <dependencies>
    <dependency>
      <groupId>org.openecomp.sdc.core</groupId>
      <artifactId>openecomp-utilities-lib</artifactId>
      <version>${project.version}</version>
    </dependency>

    <dependency>
      <groupId>org.openecomp.sdc</groupId>
      <artifactId>openecomp-sdc-logging-api</artifactId>
      <version>${project.version}</version>
    </dependency>
    <dependency>
      <groupId>org.openecomp.sdc</groupId>
      <artifactId>openecomp-sdc-logging-core</artifactId>
      <version>${project.version}</version>
      <scope>runtime</scope>
    </dependency>
    <dependency>
      <groupId>org.openecomp.sdc.core</groupId>
      <artifactId>openecomp-facade-core</artifactId>
      <version>${project.version}</version>
    </dependency>
    <dependency>
      <groupId>org.openecomp.sdc.core</groupId>
      <artifactId>openecomp-zusammen-core</artifactId>
      <version>${project.version}</version>
    </dependency>
  </dependencies>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jar-plugin</artifactId>
        <version>${mvn.jar.version}</version>
        <configuration>
          <archive>
            <manifest>
              <addDefaultImplementationEntries>
                true
              </addDefaultImplementationEntries>
            </manifest>
          </archive>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>