diff options
author | HuabingZhao <zhao.huabing@zte.com.cn> | 2017-09-27 15:40:18 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@onap.org> | 2017-09-27 15:40:18 +0000 |
commit | ec6e90960b8f8e0b068aefe3292b3d13fd3b789e (patch) | |
tree | a79edd1b567e5a14c0f1b643f611a7ee6a51d24e | |
parent | 343de47e1b5ab34a7e6035bbc7c36dbce49a30b2 (diff) | |
parent | ccdc64e1b1df89513b423eff51c8614c3ccf4c4f (diff) |
Merge "Add api docs for MSB"
-rw-r--r-- | docs/index.rst | 15 | ||||
-rw-r--r-- | docs/offeredapis.rst | 12 |
2 files changed, 26 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst index 833e1aa..8219c32 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,21 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -TODO Add files to toctree and delete this header +MSB(Microservices Bus) ------------------------------------------------ + +Microservices Bus provide key infrastructure functionalities to support ONAP microservice architecture including service registration/discovery, service gateway, service load balancer and service governance. It's a pluggable architecture so it can be extended with plugins to provide value added services such as centralized authentication for APIs. Microservices Platform also provides a GUI portal for service management. + +MSB comprises these modules: + +- MSB + - Discovery + - API Gateway + - MSB SDK + - Swagger SDK + .. toctree:: :maxdepth: 1 + + offeredapis.rst diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst new file mode 100644 index 0000000..3ceed0c --- /dev/null +++ b/docs/offeredapis.rst @@ -0,0 +1,12 @@ +MSB APIs +================================== +The MSB provides the following APIs. + +* Service Registration/Unregistration +* Service Update +* Service Discovery +* MSB Java SDK +* Swagger SDK + +- `MSB APIs <https://wiki.onap.org/display/DW/Microservice+Bus+API+Documentation>`_. +- `Swagger SDK <https://wiki.onap.org/display/DW/swagger-sdk>`_.
\ No newline at end of file |