summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBin Yang <bin.yang@windriver.com>2018-03-07 13:36:08 +0800
committerBin Yang <bin.yang@windriver.com>2018-03-07 13:36:08 +0800
commit2865eefc7233dbf3c5d8648d9871c79d3ed01795 (patch)
tree2bfa649ab754f603b3103509fdae4b70a37e8d10
parenta675dd4430cbee5f6ac41ab9c53500853e63ad26 (diff)
Add Readme to explain what share offers
Change-Id: I75f3c99f1078a3a18d068b031a4ebd406b6aa834 Issue-ID: MULTICLOUD-138 Signed-off-by: Bin Yang <bin.yang@windriver.com>
-rw-r--r--share/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/share/README.md b/share/README.md
new file mode 100644
index 00000000..abd8ac30
--- /dev/null
+++ b/share/README.md
@@ -0,0 +1,24 @@
+# Copyright (c) 2017-2018 Wind River Systems, Inc.
+#
+# 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.
+
+This is the code base extracted from plugin service for newton. It consists of:
+
+1, common utilities which is irrelevant of any SBI to openstack, just some wrapper for API interaction with other ONAP components
+
+2, newton_base which is the translation of MultiCloud NBI to OpenStack Newton NBI.
+
+Since from ONAP perspective, there are limited API requests to OpenStack, the variation between different OpenStack release could be minimal and even invisible. So the MultiCloud Plugin service for Ocata, Pike might also be able to reuse this newton_base library. With this approach we could minimize the effort to maintain MultiCloud Plugin services for various OpenStack releases
+
+3, UT helper which simulates the VIM response whenever the requests are issued towards underly OpenStack Newton.
+