From 710d958a29198b6633236c1b7cad12babfe46833 Mon Sep 17 00:00:00 2001 From: rl001m Date: Sun, 17 Dec 2017 09:04:31 -0500 Subject: Added all common modules in conductor directory Added the common modules used by all the other components of Homing Optimizer. Change-Id: I6e8a991b54ef422da66b3174f27f6998731ec188 Issue-ID: OPTFRA-11 Signed-off-by: rl001m --- conductor/README.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 conductor/README.rst (limited to 'conductor/README.rst') diff --git a/conductor/README.rst b/conductor/README.rst new file mode 100644 index 0000000..c90eff6 --- /dev/null +++ b/conductor/README.rst @@ -0,0 +1,26 @@ +========= +Conductor +========= + +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. + +* License: Licensed under the Apache License, Version 2.0 +* `PyPI`_ - package installation +* `Python/Linux Distribution Notes`_ +* `Conductor Template Guide`_ +* `Example Templates`_ +* `Homing API`_ +* `Bugs`_ - issue tracking +* `Source`_ + +.. _PyPI: +.. _Python/Linux Distribution Notes: /doc/distribution/README.md +.. _Conductor Template Guide: /doc/template/README.md +.. _Example Templates: /examples/README.md +.. _Homing API: /doc/api/README.md +.. _Bugs: https://jira.onap.org/projects/OPTFRA/summary +.. _Source: https://gerrit.onap.org/r/optf/has -- cgit 1.2.3-korg