openstack
/
murano
Code Issues Proposed changes

Update docs to reflect change from murano-api to murano 

bug: https://bugs.launchpad.net/murano/+bug/1335094
Change-Id: I9fadffea6be63451bc66748825f16c01dc825665
This commit is contained in:
Brent Roskos 2014-06-27 08:07:13 -04:00
parent eae00b9970
commit 0d705df996
7 changed files with 20 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/articles/core_classes.rst
View File

@ -21,7 +21,7 @@ MuranoPL Core Library
Some objects and actions could be used in several application deployments. All common parts are grouped into MuranoPL libraries.
Murano core library is a set of classes needed in every deployment. Class names from core library could be used in the application definitions.
This library is located under the `meta <https://github.com/stackforge/murano-api/tree/master/meta/io.murano>`_ directory.
This library is located under the `meta <https://github.com/stackforge/murano/tree/master/meta/io.murano>`_ directory.
The following classes are included into the Murano core library:
**io.murano:**

4
doc/source/index.rst
View File

@ -32,7 +32,7 @@ environments on the Application abstraction level and then manage their
lifecycle.
Murano consists of three source code repositories:
* `murano-api`_ - is the main repository. It contains code for Murano API
* `murano`_ - is the main repository. It contains code for Murano API
server, Murano engine and MuranoPL
* `murano-agent`_ - agent which runs on guest VMs and executes deployment
plan
@ -40,7 +40,7 @@ Murano consists of three source code repositories:
Dashboard
.. _murano-api: https://git.openstack.org/cgit/stackforge/murano-api/
.. _murano: https://git.openstack.org/cgit/stackforge/murano/
.. _murano-agent: https://git.openstack.org/cgit/stackforge/murano-agent/
.. _murano-dashboard: https://git.openstack.org/cgit/stackforge/murano-dashboard/

2
doc/source/install/development.rst
View File

@ -26,4 +26,4 @@ Murano with `Devstack`_.
.. _Devstack: http://www.devstack.org/
.. _contrib/devstack: https://git.openstack.org/cgit/stackforge/murano-api/tree/contrib/devstack
.. _contrib/devstack: https://git.openstack.org/cgit/stackforge/murano/tree/contrib/devstack

14
doc/source/install/manual.rst
View File

@ -58,7 +58,7 @@ Installing the API service and Engine
::
$ cd /opt/stack
$ git clone https://git.openstack.org/stackforge/murano-api.git
$ git clone https://git.openstack.org/stackforge/murano.git
2. Configure the database. Murano can run with MySQL and SQLite. MySQL is
required for produciton installation, SQLite can be used for developemnt
@ -78,10 +78,10 @@ Installing the API service and Engine
::
$ mkdir -p /etc/murano
$ cp etc/murano/murano-api.conf.sample /etc/murano/murano-api.conf
$ cp etc/murano/murano-api-paste.ini /etc/murano/
$ cp etc/murano/murano.conf.sample /etc/murano/murano.conf
$ cp etc/murano/murano-paste.ini /etc/murano/
4. Edit ``/etc/murano/murano-api.conf``
4. Edit ``/etc/murano/murano.conf``
TODO(ruhe): document configuration options
@ -89,16 +89,16 @@ Installing the API service and Engine
::
$ tox -e venv -- murano-db-manage --config-file /etc/murano/murano-api.conf upgrade
$ tox -e venv -- murano-db-manage --config-file /etc/murano/murano.conf upgrade
6. Launch Murano API service:
::
$ tox -e venv -- murano-api --config-file /etc/murano/murano-api.conf
$ tox -e venv -- murano-api --config-file /etc/murano/murano.conf
7. Launch Murano Engine service:
::
$ tox -e venv -- murano-engine --config-file /etc/murano/murano-api.conf
$ tox -e venv -- murano-engine --config-file /etc/murano/murano.conf

2
doc/source/install/prepare.rst
View File

@ -44,6 +44,8 @@ System prerequisites
* libffi-dev
* libmysqlclient-dev
*CentOS*
* gcc

8
doc/source/install/ssl.rst
View File

@ -23,7 +23,7 @@ HTTPS for Murano API
====================
SSL for Murano API service can be configured in *ssl* section in
``/etc/murano/murano-api.conf``. Just point to a valid SSL certificate.
``/etc/murano/murano.conf``. Just point to a valid SSL certificate.
See the example below:
::
@ -57,7 +57,7 @@ separately.
**Murano API <-> Rabbit MQ exchange <-> Murano Engine**
Edit ssl parameters in default section of ``/etc/murano/murano-api.conf``. Set ``rabbit_use_ssl`` option to *true* and configure ssl kombu parameters.
Edit ssl parameters in default section of ``/etc/murano/murano.conf``. Set ``rabbit_use_ssl`` option to *true* and configure ssl kombu parameters.
Specify the path to the SSL keyfile and SSL CA certificate in a regular format: /path/to/file without quotes or leave it empty to
allow self-signed certificates.
@ -84,7 +84,7 @@ allow self-signed certificates.
**Murano Agent -> Rabbit MQ exchange**
In main murano-api configuration file there is a section ,named *rabbitmq*, that is responsible for set up communication between Murano Agent and Rabbit MQ.
In main murano configuration file there is a section ,named *rabbitmq*, that is responsible for set up communication between Murano Agent and Rabbit MQ.
Just set *ssl* parameter to True to enable ssl.
::
@ -98,7 +98,7 @@ Just set *ssl* parameter to True to enable ssl.
ssl = True
If you want to configure Murano Agent in a different way change
the default template. It can be found in Murano Core Library, located at */https://github.com/stackforge/murano-api/blob/master/meta/io.murano/Resources/Agent-v1.template.* Take
the default template. It can be found in Murano Core Library, located at */https://github.com/stackforge/murano/blob/master/meta/io.murano/Resources/Agent-v1.template.* Take
a look at appSettings section:
::

6
doc/source/man/muranoapi.rst
View File

@ -45,10 +45,10 @@ OPTIONS
FILES
=====
* /etc/murano-api/murano-api.conf
* /etc/murano-api/murano-api-paste.conf
* /etc/murano/murano.conf
* /etc/murano/murano-paste.conf
SEE ALSO
========
* `Murano <http://murano-api.readthedocs.org/>`__
* `Murano <http://murano.readthedocs.org/>`__