SEBA-785 Update olt-service service documentation

Change-Id: I207d805c8c713b2a99e2d8a3b0c861bc262943b2
2 files changed
tree: 8dae0b8cce0e8d3fea8885df8544b78259d4a8fc
  1. .dockerignore
  2. .gitignore
  3. .gitreview
  4. Dockerfile.synchronizer
  5. LICENSE.txt
  6. Makefile
  7. README.md
  8. VERSION
  9. docs/
  10. requirements.txt
  11. samples/
  12. tox.ini
  13. xos/
README.md

vOLT

This repositoritory contains the XOS service that is responsible for the integration with VOLTHA.

At the moment the RCORDService assume that this service (or a service exposing the same APIs) is sitting after it in the service chain.

ONU activation discovery

This service will listen for events on the kafka bus, in the topic onu.events

The events this service will react to are:

  • onu activated

ONU Activation policy

We assume that:

  • the vOLTService service is a subscriber of MyOssService via ServiceDependency
  • MyOssService has type = oss
  • MyOssService expose and API named validate_onu
    • the validate_onu API will be responsible to create a subscriber in XOS

If no OSS Service is found in between the providers of vOLTService no action is taken as a consequence of an event.