conductor/README.rst

   1 #
   2 # -------------------------------------------------------------------------
   3 #   Copyright (c) 2015-2018 AT&T Intellectual Property
   4 #
   5 #   Licensed under the Apache License, Version 2.0 (the "License");
   6 #   you may not use this file except in compliance with the License.
   7 #   You may obtain a copy of the License at
   8 #
   9 #       http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 #   Unless required by applicable law or agreed to in writing, software
  12 #   distributed under the License is distributed on an "AS IS" BASIS,
  13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 #   See the License for the specific language governing permissions and
  15 #   limitations under the License.
  16 #
  17 # -------------------------------------------------------------------------
  18 #
  19
  20 =========
  21 Conductor
  22 =========
  23
  24 Conductor is the implementation of the Homing Service.
  25
  26 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).
  27
  28 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).
  29
  30 * Free software: License TBD
  31 * `PyPI`_ - package installation
  32 * `Python/Linux Distribution Notes`_
  33 * `Conductor Template Guide`_
  34 * `Example Templates`_
  35 * `Homing API`_
  36 * `Bugs`_ - issue tracking
  37 * `Source`_
  38