From: lizi
Date: Wed, 11 Oct 2017 08:54:32 +0000 (+0800)
Subject: Add ESR architecture detail.
X-Git-Tag: v1.0.0~11
X-Git-Url: https://gerrit.onap.org/r/gitweb?p=aai%2Fesr-server.git;a=commitdiff_plain;h=62d9cb474f057cb5a5a80fd52e7c497bb7a77dca
Add ESR architecture detail.
Change-Id: I3ffac8c813ee9f251b63bfd17a21edb03ff86d97
Issue-ID: AAI-427
Signed-off-by: lizi
---
diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst
index 18d38b0..cb658ef 100644
--- 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
diff --git a/docs/platform/images/esr-architecture.PNG b/docs/platform/images/esr-architecture.PNG
new file mode 100644
index 0000000..982a519
Binary files /dev/null and b/docs/platform/images/esr-architecture.PNG differ
diff --git a/docs/platform/images/external-system-register-progress.PNG b/docs/platform/images/external-system-register-progress.PNG
new file mode 100644
index 0000000..bcfce84
Binary files /dev/null and b/docs/platform/images/external-system-register-progress.PNG differ
diff --git a/docs/platform/images/external-system-register-sequence-diagram.PNG b/docs/platform/images/external-system-register-sequence-diagram.PNG
new file mode 100644
index 0000000..08731aa
Binary files /dev/null and b/docs/platform/images/external-system-register-sequence-diagram.PNG differ
diff --git a/docs/platform/images/vim-register-progress.PNG b/docs/platform/images/vim-register-progress.PNG
new file mode 100644
index 0000000..182e75d
Binary files /dev/null and b/docs/platform/images/vim-register-progress.PNG differ