summaryrefslogtreecommitdiffstats
path: root/conductor/README.rst
diff options
context:
space:
mode:
authorrl001m <ruilu@research.att.com>2017-12-17 09:04:31 -0500
committerrl001m <ruilu@research.att.com>2017-12-17 09:05:11 -0500
commit710d958a29198b6633236c1b7cad12babfe46833 (patch)
tree5819d23e6a3b9d4e111b3debaf41ee7fe7731a78 /conductor/README.rst
parent22cff5d3b51d9aa2d4fd11f657264e41063add1c (diff)
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 <ruilu@research.att.com>
Diffstat (limited to 'conductor/README.rst')
-rw-r--r--conductor/README.rst26
1 files changed, 26 insertions, 0 deletions
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