summaryrefslogtreecommitdiffstats
path: root/kubernetes/nbi/README.md
diff options
context:
space:
mode:
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