diff --git a/src/developers-guide/src/docbkx/content/architecture.xml b/src/developers-guide/src/docbkx/content/architecture.xml index 6f857bf..43c6c89 100644 --- a/src/developers-guide/src/docbkx/content/architecture.xml +++ b/src/developers-guide/src/docbkx/content/architecture.xml @@ -90,22 +90,6 @@ -
- Releases - - - Release-0.1 - has 0.1 tag in all Murano repositories. Released 2013-05-30. - - - - - Release-0.2 - has 0.2 tag in all Murano repositories. Released 2013-09-05. - - - -
Integration with Heat Heat is a cloud resource management engine that allows you to manipulate resources that represent diff --git a/src/developers-guide/src/docbkx/content/installation-guide.xml b/src/developers-guide/src/docbkx/content/installation-guide.xml index 9aaf48f..7783e13 100644 --- a/src/developers-guide/src/docbkx/content/installation-guide.xml +++ b/src/developers-guide/src/docbkx/content/installation-guide.xml @@ -1,247 +1,281 @@ - + - - - Install Murano - This chapter describes Murano services installation in virtual environment. - Note that all Murano modules can be downloaded from - our page - on launchpad. - -
- Pre-Requisites - Murano supports the following operating systems: - - - Ubuntu 12.04 - - - RHEL/CentOS 6.4 - - - These system packages are required for Murano: - Ubuntu - - - gcc - - - python-pip - - - python-dev - - - libxml2-dev - - - libxslt-dev - - - libffi-dev - - - - CentOS - - - - gcc - - - python-pip - - - python-devel - - - libxml2-devel - - - libxslt-devel - - - libffi-devel - - - - Before installing any packages make sure that your system is updated and upgraded. - -
-
- Installing with virtual environment - - For a local development, all Murano components can be installed in - a virtual environment. - First thing you need to do is to install check that - prerequisites are installed, system is updated and upgraded. - Next, install virtualenv package if you don't have one: - + + Install Murano + This chapter describes Murano services installation in virtual + environment. + Note that all Murano modules can be downloaded from + our page on + launchpad. +
+ Pre-Requisites + Murano supports the following operating systems: + + + Ubuntu 12.04 + + + RHEL/CentOS 6.4 + + + These system packages are required for Murano: + Ubuntu + + + gcc + + + python-pip + + + python-dev + + + libxml2-dev + + + libxslt-dev + + + libffi-dev + + + CentOS + + + gcc + + + python-pip + + + python-devel + + + libxml2-devel + + + libxslt-devel + + + libffi-devel + + + + Before installing any packages make sure that your system is + updated and upgraded. + +
+
+ Installing with virtual environment + + For a local development, all Murano components can be installed in a + virtual environment. First thing you need to do is to install check + that + prerequisites + are installed, system is updated and upgraded. Next, install + virtualenv package if you don't have one: + sudo pip install virtualenv - - Murano Api - - - - Check out git repository with murano component: - + + + Murano Api + + + + Check out git repository with murano component: + git clone https://github.com/stackforge/murano-api - - - - - Execute a script located at the murano-api/tools directory - to create virtual environment automatically: - + + + + + Execute a script located at the + murano-api/tools + directory to create virtual environment automatically: + cd murano-api && python ./tools/install_venv.py - - - - - Config files are etc/murano-api.conf - where you just need to point out IP address where your RabbitMQ is - running, and etc/murano-api-paste.ini, which doesn't require any changes. - - - - And finally run Murano API: - + + + + Config files are etc/murano-api.conf + where you just need to point out IP address where your RabbitMQ is + running, and etc/murano-api-paste.ini, which + doesn't require any changes. + + + + And finally run Murano API: + ./tools/with_venv.sh python muranoapi/cmd/api.py --config-file=./etc/murano-api.conf - - - - - - Murano Conductor - - - - Check out git repository with murano component: - + + + + + + Murano Conductor + + + + Check out git repository with murano component: + git clone https://github.com/stackforge/murano-conductor - - - - - Execute a script located at the - murano-conductor/tools directory - to create virtual environment automatically: - + + + + + Execute a script located at the + murano-conductor/tools + directory to create virtual environment automatically: + cd murano-conductor && python ./tools/install_venv.py - - - - Murano Conductor config file located at etc/conductor.conf - For a local development comment data_dir parameter in this file: - -# Directory where conductor's data directory located. -# "data" must be subdirectory to this. + + + + + Murano Conductor config file located at + etc/conductor.conf + For a local development comment data_dir parameter in this file: + +# Directory where conductor's data directory located. +# "data" must be subdirectory to this. # data_dir = /etc/murano-conductor - After that local data - directory, which contain all necessary files will be - used. All other possible configuration described in the Murano Admin Guide. - - - - Run Murano Conductor: - + After that local + data + directory, which contain all necessary files will be used. All + other possible configuration described in the Murano Admin Guide. + + + + + Run Murano Conductor: + ./tools/with_venv.sh python muranoconductor/cmd/run.py --config-file=./etc/conductor.conf - - - - - - Murano Dashboard - - - - Check out git repository with murano component: - + + + + + + Murano Repository + + + + Check out git repository with murano component: + +git clone https://github.com/stackforge/murano-repository + + + + + + Execute a script located at the + murano-repository/tools + directory to create virtual environment automatically: + +cd murano-repository && python ./tools/install_venv.py + + + + + Copy a config file + etc/murano-repository.conf.sample to + etc/murano-repository.conf and point out Keystone parameters. + + + + And finally run Murano Repository: + +./tools/with_venv.sh python muranorepository/cmd/run.py --config-file=./etc/murano-repository.conf + + + + + + Murano Dashboard + + + + Check out git repository with murano component: + git clone https://github.com/stackforge/murano-dashboard - - - - - Execute a script located at the - murano-dashboard/tools directory - to create virtual environment automatically: - + + + + + Execute a script located at the + murano-dashboard/tools + directory to create virtual environment automatically: + cd murano-dashboard && python ./tools/install_venv.py - - - - - Murano is a plugin for a Openstack dashboard. So need to install it and it's dependency: - - - - + + + + + Murano is a plugin for a Openstack dashboard. So need to install + it and it's dependency: + + + + # ./tools/with_venv.sh pip install https://github.com/openstack/horizon/archive/grizzly-2.tar.gz - Ubuntu - + Ubuntu + # apt-get install nodejs - CentOS - + CentOS + # yum install nodejs - - - - - - - - To configure Murano Dashboard copy example config file: - + + + + + + + + To configure Murano Dashboard copy example config file: + # cp muranodashboard/local/local_settings.py.example muranodashboard/local/local_settings.py - and set in just copied file the the actual IP address of the OpenStack end-point. - If you haven't register murano-api service in the keystone catalog you can set MURANO_API_URL in the same settings file. - Note that local murano-api service will be using by default. - - - - Run Murano Dashboard: - To start the Murano development server use the Django - manage.py utility with the context of the virtual - environment: - + and set in just copied file the the actual IP address of the + OpenStack end-point. If you haven't register murano-api + service in the keystone catalog you can set MURANO_API_URL in the + same settings file. Note that local murano-api service will be + using by default. + + + + + Run Murano Dashboard: + To start the Murano development server use the Django manage.py + utility with the context of the virtual environment: + ./tools/with_venv.sh ./manage.py runserver 0.0.0.0:8080 - - - -
- \ No newline at end of file + + + +
+ diff --git a/src/developers-guide/src/docbkx/content/releases.xml b/src/developers-guide/src/docbkx/content/releases.xml new file mode 100644 index 0000000..8550904 --- /dev/null +++ b/src/developers-guide/src/docbkx/content/releases.xml @@ -0,0 +1,58 @@ + + + + Release History + + Murano Releases + + + + + + + Release + Tag + Date + + + + + Release-0.1 + 0.1 + 2013-05-30 + + + Release-0.2 + 0.2 + 2013-09-05 + + + Release-0.2.11 + 0.2.11 + 2013-10-01 + + + Release-0.2.12 + 0.2.12 + 2013-11-18 + + + Release-0.3 + 0.3 + 2013-11-25 + + + +
+ diff --git a/src/developers-guide/src/docbkx/developers-guide.xml b/src/developers-guide/src/docbkx/developers-guide.xml index 7c5b512..20972f6 100644 --- a/src/developers-guide/src/docbkx/developers-guide.xml +++ b/src/developers-guide/src/docbkx/developers-guide.xml @@ -41,6 +41,7 @@ + How To Participate If you would like to ask some questions or make proposals, feel free to reach us on #murano irc channel at