aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBorislav Glozman <Borislav.Glozman@amdocs.com>2018-11-27 10:58:44 +0000
committerGerrit Code Review <gerrit@onap.org>2018-11-27 10:58:44 +0000
commitfb7a50923bc86b46a713617561a9c8e54f64f7e9 (patch)
treea48587ee73481d3636b014d2845896c1a9ef6c99
parent0c7bde336719413cf73224d2197b6677e9ba46cc (diff)
parent0db1756099c3aa131a1072411d52a87c65f53f6d (diff)
Merge "README for NBI"
-rw-r--r--kubernetes/nbi/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/kubernetes/nbi/README.md b/kubernetes/nbi/README.md
new file mode 100644
index 0000000000..9d79efe618
--- /dev/null
+++ b/kubernetes/nbi/README.md
@@ -0,0 +1,17 @@
+# NBI
+
+## Introduction
+
+NBI stands for NorthBound Interface. It brings to ONAP a set of API that can be
+used by external systems as BSS for example. These API are based on TMF API.
+
+Full description is on [ONAP Read the Doc](https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/offeredapis/index.html).
+
+## Requirements
+
+NBI needs the following ONAP projects to work:
+
+- AAI
+- SO
+- SDC
+- MSB