From b7e6105be27b5d386bd7b81c9f6554f4d6a812bf Mon Sep 17 00:00:00 2001 From: Ulas Kozat Date: Thu, 14 Jul 2016 14:57:27 -0700 Subject: Update userguide Change-Id: I3c816a7a1770c0fae8d8000a4d24e2516e94978a Signed-off-by: Ulas Kozat --- docs/userguide/index.rst | 8 +++++--- docs/userguide/overview.rst | 28 ++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 3 deletions(-) create mode 100644 docs/userguide/overview.rst (limited to 'docs/userguide') diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index aaa8f97..71f66c4 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -6,9 +6,10 @@ :width: 200 :alt: OPNFV :align: left - -DOMINO API DOCUMENTATION -======================== +| +| +Domino User Guide +================= Contents: @@ -16,6 +17,7 @@ Contents: :numbered: :maxdepth: 4 + overview.rst api-documentation.rst Indices and tables diff --git a/docs/userguide/overview.rst b/docs/userguide/overview.rst new file mode 100644 index 0000000..5941252 --- /dev/null +++ b/docs/userguide/overview.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left +.. these two pipes are to seperate the logo from the first title +| +| +Domino Overview +=============== +Domino provides a distribution service for Network Service (NS) and Virtual +Network Function (VNF) descriptors. It is targeted towards supporting many +network controllers, service orchestrators, VNF managers, Operation and +Business Support Systems. Producers of Network Service Descriptors (NSDs) +and VNF Descriptors (VNFD) use Domino Service as an entry point to publish +these descriptors. Currently Domino only supports Tosca Simple Profile for +Network Functions Virtualization (http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/tosca-nfv-v1.0.html) as the data model for NSDs and VNFDs. + +Orchestrators, controllers, and managers use Domino service to announce their +capabilities in the form of policy labels. For instance a Virtual Infrastructure +Manager (VIM) that is capable of performing an affinity based VNF or VDU +placement at host machine granularity can specify a label in the form "tosca.policies.Placement.affinity:properties:granularity:hostlevel". When the VIM registers +with Domino Service and subscribed for that label, Domino views this VIM as a +candidate location that can host a VNF or VDU requesting affinity based placement +policy at host machine granularity. -- cgit 1.2.3-korg