over the re-creation of a container. Persistent volumes have been created for
the database components of each of the projects and the same technique can be
used for all persistent state information.
-
-
-
-Environment Files
-~~~~~~~~~~~~~~~~~
-
-MSB Integration
-===============
-
-The \ `Microservices Bus
-Project <https://wiki.onap.org/pages/viewpage.action?pageId=3246982>`__ provides
-facilities to integrate micro-services into ONAP and therefore needs to
-integrate into OOM - primarily through Consul which is the backend of
-MSB service discovery. The following is a brief description of how this
-integration will be done:
-
-A registrator to push the service endpoint info to MSB service
-discovery.
-
-- The needed service endpoint info is put into the kubernetes yaml file
- as annotation, including service name, Protocol,version, visual
- range,LB method, IP, Port,etc.
-
-- OOM deploy/start/restart/scale in/scale out/upgrade ONAP components
-
-- Registrator watch the kubernetes event
-
-- When an ONAP component instance has been started/destroyed by OOM,
- Registrator get the notification from kubernetes
-
-- Registrator parse the service endpoint info from annotation and
- register/update/unregister it to MSB service discovery
-
-- MSB API Gateway uses the service endpoint info for service routing
- and load balancing.
-
-Details of the registration service API can be found at \ `Microservice
-Bus API
-Documentation <https://wiki.onap.org/display/DW/Microservice+Bus+API+Documentation>`__.
-
-ONAP Component Registration to MSB
-----------------------------------
-The charts of all ONAP components intending to register against MSB must have
-an annotation in their service(s) template. A `sdc` example follows:
-
-.. code-block:: yaml
-
- apiVersion: v1
- kind: Service
- metadata:
- labels:
- app: sdc-be
- name: sdc-be
- namespace: "{{ .Values.nsPrefix }}"
- annotations:
- msb.onap.org/service-info: '[
- {
- "serviceName": "sdc",
- "version": "v1",
- "url": "/sdc/v1",
- "protocol": "REST",
- "port": "8080",
- "visualRange":"1"
- },
- {
- "serviceName": "sdc-deprecated",
- "version": "v1",
- "url": "/sdc/v1",
- "protocol": "REST",
- "port": "8080",
- "visualRange":"1",
- "path":"/sdc/v1"
- }
- ]'
- ...
-
-
-MSB Integration with OOM
-------------------------
-A preliminary view of the OOM-MSB integration is as follows:
-
-.. figure:: ../../resources/images/msb/MSB-OOM-Diagram.png
-
-A message sequence chart of the registration process:
-
-.. uml::
-
- participant "OOM" as oom
- participant "ONAP Component" as onap
- participant "Service Discovery" as sd
- participant "External API Gateway" as eagw
- participant "Router (Internal API Gateway)" as iagw
-
- box "MSB" #LightBlue
- participant sd
- participant eagw
- participant iagw
- end box
-
- == Deploy Servcie ==
-
- oom -> onap: Deploy
- oom -> sd: Register service endpoints
- sd -> eagw: Services exposed to external system
- sd -> iagw: Services for internal use
-
- == Component Life-cycle Management ==
-
- oom -> onap: Start/Stop/Scale/Migrate/Upgrade
- oom -> sd: Update service info
- sd -> eagw: Update service info
- sd -> iagw: Update service info
-
- == Service Health Check ==
-
- sd -> onap: Check the health of service
- sd -> eagw: Update service status
- sd -> iagw: Update service status
-
-
-MSB Deployment Instructions
----------------------------
-MSB is helm installable ONAP component which is often automatically deployed.
-To install it individually enter::
-
- > helm install <repo-name>/msb
-
-.. note::
- TBD: Vaidate if the following procedure is still required.
-
-Please note that Kubernetes authentication token must be set at
-*kubernetes/kube2msb/values.yaml* so the kube2msb registrator can get the
-access to watch the kubernetes events and get service annotation by
-Kubernetes APIs. The token can be found in the kubectl configuration file
-*~/.kube/config*
-
-More details can be found here `MSB installation <https://docs.onap.org/projects/onap-msb-apigateway/en/latest/platform/installation.html>`_.
-
-.. MISC
-.. ====
-.. Note that although OOM uses Kubernetes facilities to minimize the effort
-.. required of the ONAP component owners to implement a successful rolling
-.. upgrade strategy there are other considerations that must be taken into
-.. consideration.
-.. For example, external APIs - both internal and external to ONAP - should be
-.. designed to gracefully accept transactions from a peer at a different
-.. software version to avoid deadlock situations. Embedded version codes in
-.. messages may facilitate such capabilities.
-..
-.. Within each of the projects a new configuration repository contains all of
-.. the project specific configuration artifacts. As changes are made within
-.. the project, it's the responsibility of the project team to make appropriate
-.. changes to the configuration data.
Code Review / oom.git / commitdiff