diff --git a/conductor/README.rst b/conductor/README.rst new file mode 100644 index 00000000..38cfa96f --- /dev/null +++ b/conductor/README.rst @@ -0,0 +1,8 @@ +Glazier Conductor README +======================== +Conductor is an Glazier orchestration engine that transforms object model sent by +REST API service into a series of Heat and Glazier-Agent commands + +SEE ALSO +-------- +* `Keero `__ diff --git a/conductor/doc/source/index.rst b/conductor/doc/source/index.rst index 50ce1427..ea1b15b3 100644 --- a/conductor/doc/source/index.rst +++ b/conductor/doc/source/index.rst @@ -1,5 +1,5 @@ .. - Copyright 2013, Mirantis Inc. + Copyright 2010 OpenStack Foundation All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may @@ -14,7 +14,59 @@ License for the specific language governing permissions and limitations under the License. -Welcome to Conductor's documentation! -================================== +======================================================= +Welcome to Conductor, the Glazier orchestration engine! +======================================================= + +Conductor is an Glazier orchestration engine that transforms object model sent by +REST API service into a series of Heat and Glazier-Agent commands + +This document describes Conductor for contributors of the project. + +This documentation is generated by the Sphinx toolkit and lives in the source +tree. + +Installation Guide +================== +Install +------- + + Check out sources to some directory (/glazier): + + smelikyan@work:~/git clone ssh://@gerrit.mirantis.com:29418/keero/keero.git + + Install Conductor: + + smelikyan@work:~/cd glazier/conductor && sudo python setup.py install + +Configure +--------- + + Open configuration file for editing: + + smelikyan@work:~/cd glazier/conductor/etc && nano conductor.conf + + Configure according to you environment: + [DEFAULT] + log_file = logs/conductor.log + debug=True + verbose=True + + [heat] + auth_url = http://localhost:5000/v2.0 + + [rabbitmq] + # this must be IP or hostname accessible from instances (VMs) + host = YOUR.REAL.IP.HERE + port = 5672 + virtual_host = glazier + login = glazier + password = glazier + +Run +---- + +Run Conductor and supply valid configuration file: + +smelikyan@work:~/cd glazier/conductor && conductor --config-file=./glazier/conductor/etc/conductor.conf -We rule the world! \ No newline at end of file