aboutsummaryrefslogtreecommitdiffstats
path: root/kubernetes/nbi/README.md
diff options
context:
space:
mode:
authorSylvain Desbureaux <sylvain.desbureaux@orange.com>2018-11-27 10:40:41 +0100
committerSylvain Desbureaux <sylvain.desbureaux@orange.com>2018-11-27 10:40:41 +0100
commit0db1756099c3aa131a1072411d52a87c65f53f6d (patch)
tree2b58370332bd54cd598e1ac44a71ec78d1a2014d /kubernetes/nbi/README.md
parent2034ea7a185f91a631991f436963cc08ad3f4315 (diff)
README for NBI
when looking at OOM Charts, it's important to know what they're deploying and what are the requirements. This commit is doing it for NBI project Change-Id: I8200bc1a2ce06073af898a38ef4d72511969d03d Issue-ID: OOM-1453 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com>
Diffstat (limited to 'kubernetes/nbi/README.md')
-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