summaryrefslogtreecommitdiffstats
path: root/conductor
diff options
context:
space:
mode:
authorIkram Ikramullah (ikram@research.att.com) <ikram@research.att.com>2018-03-04 11:10:14 -0500
committerIkram Ikramullah (ikram@research.att.com) <ikram@research.att.com>2018-03-04 11:49:15 -0500
commitf435815bb8a16235a930856dfa846bb05d181c85 (patch)
tree99eec82cbe96ca6397bf8dca78de8d7874a3e58d /conductor
parentda2f81ccb94a5830341da4a17b251a40fac6a6b9 (diff)
Version.py must match setup.cfg
pip install -e . command was failing due to project name mismatch in version.py (pbr settings) and setup.cfg. Also, README.rst is a required file - must be present in the directory pip install is run from (needed by setup.py). Copied README.rst (and its markdown counterpart - README.md) to one level in (./conductor). Issue-ID: OPTFRA-161 Change-Id: I76e8e9c7d303a1e82524635118af3de36bc1a361 Signed-off-by: Ikram Ikramullah (ikram@research.att.com) <ikram@research.att.com>
Diffstat (limited to 'conductor')
-rw-r--r--conductor/conductor/README.md16
-rw-r--r--conductor/conductor/README.rst26
-rw-r--r--conductor/conductor/version.py2
3 files changed, 43 insertions, 1 deletions
diff --git a/conductor/conductor/README.md b/conductor/conductor/README.md
new file mode 100644
index 0000000..ba0316d
--- /dev/null
+++ b/conductor/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)
diff --git a/conductor/conductor/README.rst b/conductor/conductor/README.rst
new file mode 100644
index 0000000..c90eff6
--- /dev/null
+++ b/conductor/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
diff --git a/conductor/conductor/version.py b/conductor/conductor/version.py
index 6cdecfe..79e8478 100644
--- a/conductor/conductor/version.py
+++ b/conductor/conductor/version.py
@@ -19,4 +19,4 @@
import pbr.version
-version_info = pbr.version.VersionInfo('of_has')
+version_info = pbr.version.VersionInfo('of-has')