summaryrefslogtreecommitdiffstats
path: root/conductor
diff options
context:
space:
mode:
authorrl001m <ruilu@research.att.com>2017-12-15 15:49:01 -0500
committerrl001m <ruilu@research.att.com>2017-12-15 17:34:20 -0500
commit22cff5d3b51d9aa2d4fd11f657264e41063add1c (patch)
tree961803d8444c512d232446ac12db0e42462a92f4 /conductor
parent15abbf4bf4bfd204cac504b68b5d3bfe89079c6b (diff)
Added conductor directory and README file
Added conductor directory and README file. The README file contains the description of ONAP Condcutor and license. Change-Id: I8dd6b65152f45ff6102dcdc0ba99c31c42d958ea Issue-ID: OPTFRA-10 Signed-off-by: rl001m <ruilu@research.att.com>
Diffstat (limited to 'conductor')
-rw-r--r--conductor/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/conductor/README.md b/conductor/README.md
new file mode 100644
index 0000000..ba0316d
--- /dev/null
+++ b/conductor/README.md
@@ -0,0 +1,16 @@
+# 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](/doc/distribution/README.md)
+* [Conductor Template Guide](/doc/template/README.md)
+* [Example Templates](/doc/examples/README.md)
+* [Homing API](/doc/api/README.md)
+* [Bugs](https://jira.onap.org/projects/OPTFRA/summary) - issue tracking
+* [Source](https://gerrit.onap.org/r/optf/has)