Digestion to ONAP

This commit contains features added across previous iteration.
Unfortunatley, its hard to separate out all the features / defect fixes
under the current setup unless an automated ingestion and integration
mechanims is in place.

Following are the details of each feature / defect fix.

- (OPTFRA-347) New Music Response Changes
Required changes for upgrading to music version 3.x

- (OPTFRA-346) Triage Tool Feature Changes
Triage tool for finding out issues with candidates and how they were dropped

- (OPTFRA-280) Order Locking Feature Changes
Orders from SO need to be parked (and later retriggered) in
scenarios where the orchestration of the already given solution
is in progress.

- (OPTFRA-281) Latency Based Homing
This features enables homing based on 'network latency' defined in
has's internally maintained tables instead of plain distance.

Other defect fixes / performance improvements
- AAI Timeout give up change
Defect fix related to dropping candidates when AAI timed out
and didn't retrun within 3 tries. has will now give up in these
scenarios.

- Defect fix replaced all() query with status based query. There was no need to reachout to Music to grab the whole plans
table - we now go only by the value of the status field.

Issue-ID: OPTFRA-280
Change-Id: I47fa7651c5c81763770771d6f7e7ff4ab155d18e
Signed-off-by: rl001m <ruilu@research.att.com>

1 files changed, 38 insertions, 0 deletions

diff --git a/conductor/README.rst b/conductor/README.rst
new file mode 100644
index 0000000..6d67fd0
--- /dev/null
+++ b/conductor/README.rst
@@ -0,0 +1,38 @@
+#
+# -------------------------------------------------------------------------
+#   Copyright (c) 2015-2018 AT&T Intellectual Property
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+# -------------------------------------------------------------------------
+#
+
+=========
+Conductor
+=========
+
+Conductor is the implementation of the Homing Service.
+
+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).
+
+The formal project name is *Conductor*. 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. References to *Homing Conductor* are a misnomer. Instead, refer to the project name (Conductor) or the canonical name (homing service).
+
+* Free software: License TBD
+* `PyPI`_ - package installation
+* `Python/Linux Distribution Notes`_
+* `Conductor Template Guide`_
+* `Example Templates`_
+* `Homing API`_
+* `Bugs`_ - issue tracking
+* `Source`_
+