summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorfsandoval <frank.sandoval@oamtechnologies.com>2018-05-27 14:07:53 -0600
committerfsandoval <frank.sandoval@oamtechnologies.com>2018-05-27 14:08:08 -0600
commitb814e2ac26400bdc8ca5f204b2c2072c49fc78d6 (patch)
tree22f28ced829d253ffc851702bc1c3ef273ea4466 /docs/index.rst
parent9ed3be523a23ac6f46898070d398dc5ed9578d92 (diff)
consolidated docs
Issue-ID: OPTFRA-242 Change-Id: I1440436559496cf688c66a13accdaeb0df0160c9 Signed-off-by: fsandoval <frank.sandoval@oamtechnologies.com>
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst19
1 files changed, 17 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst
index afea941..69b61c3 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -21,18 +21,33 @@ for wider range of services, e.g., DCAE micro-services, ECOMP control loops, ser
Finally, HAS provides an traceable mechanism for what-if analysis which is critical for ease of
understanding a homing recommendation and resolving infeasibility scenarios.
+OF-HAS is the implementation of the ONAP Homing Service. The formal project name in ONAP is *OF-HAS*.
+The informal name for the project is *Conductor* (inherited from the seed-code), which is interchangeably
+used through the project.
+
+Given the description of what needs to be deployed (demands) and the placement requirements (constraints),
+Conductor determines placement candidates that meet all constraints while optimizing the resource usage
+of the AIC infrastructure. A customer request may be satisfied by deploying new VMs in AIC (AIC inventory)
+or by using existing service instances with enough remaining capacity (service inventory).
+
+From a canonical standpoint, Conductor is known as a *homing service*, in the same way OpenStack Heat
+is an orchestration service, or Nova is a compute service.
+
+
.. toctree::
:maxdepth: 1
./sections/architecture.rst
- ./sections/homingspecification.rst
./sections/offeredapis.rst
+ ./sections/homingspecification.rst
./sections/consumedapis.rst
- ./sections/delivery.rst
+ Distribution <./sections/distribution.rst>
./sections/logging.rst
./sections/installation.rst
./sections/configuration.rst
./sections/administration.rst
./sections/humaninterfaces.rst
+ ./sections/glossary.rst
+ Example Homing Templates <./sections/example.rst>
./sections/release-notes.rst