Add ESR architecture detail.

[aai/esr-server.git] / docs / platform / architecture.rst

diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst
index 18d38b0..cb658ef 100644 (file)
--- a/docs/platform/architecture.rst
+++ b/docs/platform/architecture.rst
@@ -4,4 +4,27 @@
 Architecture
 ------------
 
+ESR contains two components: esr server module and esr gui module
 
+- ESR
+    - ESR server
+    - ESR gui
+
+ONAP-level Architecture
+^^^^^^^^^^^^^^^^^^^^^^^
+
+In ONAP architecture, ESR is a sub-project of A&AI. It provide a single point for users to manage the external system information. It provides a way to register/unregister external system dynamically.
+
+.. image:: images/esr-architecture.PNG
+
+How ESR works
+^^^^^^^^^^^^^^^^^^^^^^^
+
+The user register external system through esr-gui, esr-server will store the external system information to A&AI. And the other components such as VF-C/SDNC/Multi-Cloud then can query the external system information form A&AI. The process of VIM register may be a bit different from the VNFM/EMS/thirdparty SDNC. That because the registered VIM information is some basic information such as region/version/auth-url that things, Multi-Cloud will update the cloud information with more details, such as the volume and tenant details. The VNFM/EMS/thirdparty SDNC will not be updated by VF-C and SDNC.
+
+.. image:: images/vim-register-progress.PNG
+.. image:: images/external-system-register-progress.PNG
+
+The complete workflow is shown below in the form of a sequence diagram.
+
+.. image:: images/external-system-register-sequence-diagram.PNG
\ No newline at end of file