stackforge-attic/murano-docs
Code Issues Proposed changes

Update Getting-Started Guide with Release-0.4 information

Browse Source 
Change-Id: I1789ec8fa305648481b3706cd1f89534eadf0e02
This commit is contained in:
Ekaterina Fedorova 2013-12-10 10:26:37 +04:00
parent 5dc1a0fcad
commit f666477b00
4 changed files with 84 additions and 35 deletions

57
src/getting-started/src/docbkx/content/overview.xml

@ -23,42 +23,54 @@
version="5.0">
<title>About Murano</title>
<para>
Murano is a new service which allows a non-experienced user to deploy
reliable Windows based environments in OpenStack with the "One Click". The
key goal is to provide a UI and API enabling the deployment and
operation of Windows Environments at the Windows Services abstraction
level. The service is able to orchestrate complex circular dependent
cases in order to set up a complex Windows Environment with multiple
dependant services.
Murano Project introduces an application catalog, which allows application developers
and cloud administrators to publish various cloud-ready applications in a browsable
categorised catalog, which may be used by the cloud users (including the unexperienced ones)
to pick-up the needed applications and services and composes the reliable environments out of
them in a “push-the-button” manner. Key goal is to provide UI and API which allows to compose
and deploy composite environments on the Application abstraction level and then manage their
lifecycle. The Service should be able to orchestrate complex circular dependent cases in order
to setup complete environments with many dependant applications and services. However, the
actual deployment itself will be done by the existing software orchestration tools (such as Heat),
while the Murano project will become an integration point for various applications and services.
</para>
<para>
The service addresses following use cases:
<itemizedlist>
<listitem>
<para>Self-deploying of predefined Windows services with their dependencies</para>
<para>Self-deploying of predefined Services with their dependencies</para>
</listitem>
<listitem>
<para>Automation of administrative tasks during data center roll-out</para>
</listitem>
<listitem>
<para>Custom windows application as a windows service</para>
<para>Custom windows application as a Windows Service</para>
</listitem>
<listitem>
<para>Custom linux application as a Linux Service</para>
</listitem>
</itemizedlist>
</para>
<para>
The solution provides higher level of abstraction for manipulation
Windows Environments. Key concepts are:
The solution provides higher level of abstraction for manipulation applications. Key concepts are:
<itemizedlist>
<listitem>
<para>Windows Service - a service such as Active Directory, MsSQL, or IIS, which usually consists of multiple virtual machines (VM) and has multiple dependencies.
</para>
</listitem>
<listitem>
<para>Windows Environment - a logical unit for all Services and represents a classical Windows Datacenter.
<listitem>
<para>Linux Service - a service such as Apache Server can be easily preconfigured and installed in 1-Click
</para>
</listitem>
<listitem>
<para>Windows VM instance - a VM which hosts a Windows Service. A Windows Service might be deployed over several Windows VM instances.</para>
<para>Environment - a logical unit for one or several Services.
</para>
</listitem>
<listitem>
<para>VM instance - a VM which hosts a Service. A Service might be deployed over several VM instances.</para>
</listitem>
<listitem>
<para>Metadata Service - Service that provides opportunity to manage custom services definitions.</para>
</listitem>
</itemizedlist>
</para>
@ -75,7 +87,7 @@
<para>Supports Availability Zones and Disaster Recovery scenarios</para>
</listitem>
<listitem>
<para>Uses native Windows features for High Availabillity (HA) solutions</para>
<para>Uses native Windows features for High Availability (HA) solutions</para>
</listitem>
</orderedlist>
</para>
@ -92,8 +104,8 @@
</thead>
<tbody>
<tr>
<td colspan="1" align="center">September. 4, 2013</td>
<td colspan="3" align="center">Release-0.2</td>
<td colspan="1" align="center"> September. 4, 2013 </td>
<td colspan="3" align="center"> Release-0.2 </td>
<td colspan="4">
<itemizedlist>
<listitem>
@ -102,6 +114,17 @@
</itemizedlist>
</td>
</tr>
<tr>
<td colspan="1" align="center"> December. 9, 2013 </td>
<td colspan="3" align="center"> Release-0.4 </td>
<td colspan="4">
<itemizedlist>
<listitem>
<para>Update with Release-0.4 information</para>
</listitem>
</itemizedlist>
</td>
</tr>
</tbody>
</informaltable>
</section>

39
src/getting-started/src/docbkx/content/setup_devbox.xml

@ -92,7 +92,7 @@
</itemizedlist>
<programlisting>
># cd murano-deployment/getting-started
># git checkout -b release-0.2 origin/release-0.2
># git checkout -b release-0.4 origin/release-0.4
</programlisting>
<itemizedlist>
<listitem>
@ -149,11 +149,11 @@ LAB_HOST='***.***.***.***'
</programlisting>
<itemizedlist>
<listitem>
<para>Clone murano-deployment repository from branch release-0.2:</para>
<para>Clone murano-deployment repository from branch release-0.4:</para>
</listitem>
</itemizedlist>
<programlisting>
># git clone git://github.com/stackforge/murano-deployment.git -b release-0.2
># git clone git://github.com/stackforge/murano-deployment.git -b release-0.4
</programlisting>
<itemizedlist>
<listitem>
@ -171,20 +171,35 @@ LAB_HOST='***.***.***.***'
</listitem>
</itemizedlist>
<programlisting>
LAB_HOST='***.***.***.***'
LAB_HOST=''
AUTH_URL="http://$LAB_HOST:5000/v2.0"
ADMIN_USER=''
ADMIN_PASSWORD=''
ADMIN_USER='admin'
ADMIN_PASSWORD='***'
RABBITMQ_LOGIN=''
RABBITMQ_PASSWORD=''
RABBITMQ_VHOST=''
RABBITMQ_PORT=''
RABBITMQ_LOGIN='muranouser'
RABBITMQ_PASSWORD='murano'
RABBITMQ_VHOST='muranovhost'
RABBITMQ_PORT='****'
BRANCH_NAME='release-0.3'
# Equals to LAB_HOST by default
#RABBITMQ_HOST=''
#RABBITMQ_HOST_ALT=''
#FILE_SHARE_HOST=''
BRANCH_NAME='release-0.4'
# Only 'true' or 'false' values are allowed!
SSL_ENABLED='false'
SSL_CA_FILE=''
SSL_CERT_FILE=''
SSL_KEY_FILE=''
#BRANCH_MURANO_API=''
#BRANCH_MURANO_DASHBOARD=''
#BRANCH_MURANO_CLIENT=''
#BRANCH_MURANO_CONDUCTOR=''
#BRANCH_MURANO_REPOSITORY=''
</programlisting>
<para>It's recommended to use separate vHost in <link linkend="Rabbit">RabbitMQ</link>.</para>
<para>Then some additional system packages will be installed.</para>

9
src/getting-started/src/docbkx/content/setup_lab_environment.xml

@ -472,11 +472,11 @@
</section>
<section xml:id="Keystone">
<title>Keystone Configuration Notes</title>
<para>Service entry for murano-api and endpoint associated with it
<para>Service entry and endpoint associated with it for murano-api and murano-repository
could also be configured in the keystone. If there is no record
about murano-api in the keystone murano-dashboard would try to
reach murano-api service at localhost on the default murano-api
port 8082.
port 8082.(8084 in case of murano-repository)
</para>
<para>How to add service record into the keystone using python keystone
client:
@ -484,6 +484,11 @@
># keystone service-create --name muranoapi --type murano \
--description "Murano-Api Service"
</programlisting>
And for murano-repository:
<programlisting>
># keystone service-create --name murano-repository --type murano-repository \
--description "Murano-Repository Service"
</programlisting>
This command returns UUID of the created service record, which
should be used below.
<programlisting>

14
src/getting-started/src/docbkx/content/troubleshooting.xml

@ -129,10 +129,16 @@
<para><emphasis role="bold">Murano Log Files</emphasis></para>
<itemizedlist>
<listitem>
<para>/var/log/murano-api.log</para>
<para>/var/log/murano/murano-api.log</para>
</listitem>
<listitem>
<para>/var/log/murano-conductor.log</para>
<para>/var/log/murano/murano-conductor.log</para>
</listitem>
<listitem>
<para>/var/log/murano/murano-dashboard.log</para>
</listitem>
<listitem>
<para>/var/log/murano/murano-repository.log</para>
</listitem>
<listitem>
<para>/var/log/apache2/errors.log
@ -142,7 +148,7 @@
<para>/var/log/httpd/errors.log</para>
</listitem>
</itemizedlist>
<para><emphasis role="bold">Windows Log Files</emphasis></para>
<para><emphasis role="bold">Windows Log Files (on VM's)</emphasis></para>
<itemizedlist>
<listitem>
<para>C:\Murano\PowerShell.log</para>
@ -152,4 +158,4 @@
</listitem>
</itemizedlist>
</section>
</chapter>
</chapter>