stackforge-attic/murano-docs
Code Issues Proposed changes

Update user-guide for 0.5 release

Browse Source 
Change-Id: If0c7cc5ec78e0902cfc2a788cf2d6b7b31aefefc
This commit is contained in:
Ekaterina Fedorova 2014-04-28 18:13:01 +04:00
parent e06d7b4eae
commit e72614d125
51 changed files with 1528 additions and 1146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/user-guide/pom.xml
View File

@ -20,7 +20,7 @@
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<groupId>com.mirantis.murano</groupId> <groupId>com.mirantis.murano</groupId>
<artifactId>user-guide</artifactId> <artifactId>user-guide</artifactId>
<version>0.3</version> <version>0.5</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<name>Murano User Guide</name> <name>Murano User Guide</name>
<build> <build>

1114
src/user-guide/src/docbkx/content/app_catalog.xml Normal file
View File

File diff suppressed because it is too large Load Diff

922
src/user-guide/src/docbkx/content/environments.xml
View File

@ -1,922 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2013 Mirantis, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xlink="http://www.w3.org/1999/xlink"
xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd"
version="5.0">
<title>Environments</title>
<para>
<emphasis role="bold"> Murano Environment </emphasis> - a virtual unit to store different services (applications).
They can be connected with each other or be individual. The following actions with environment are available:
<itemizedlist>
<listitem>
<para>Create;</para>
</listitem>
<listitem>
<para>Edit;</para>
</listitem>
<listitem>
<para>Delete;</para>
</listitem>
<listitem>
<para>Deploy.</para>
</listitem>
</itemizedlist>
More information about actions with environment are described in this chapter.
</para>
<section>
<title>Creating environment</title>
<para>Once you installed all Murano components and logged-in to horizon dashboard successfully you will see Murano tab:</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/Environments/main-envs.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>
First thing you need to do is to create an environment.
To do this, navigate to the
<filename>Deployment > Environments</filename>
page and click to the
<filename>"Create Environment"</filename>
. After setting name to your virtual environment it will be created.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/Environments/create-env.png" scalefit="1"
width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>
Just created environment has status <emphasis>Ready to configure</emphasis>.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/Environments/created-env.jpg" scalefit="1"
width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</section>
<section>
<title>Adding application to the environment</title>
<para >
After Environment is created, you need to add applications to this environment
and then deploy the Environment. When deploy process is done instances
with your aplications will be spawned in OpenStack.
To add an application navigate to page with the list of environment services by
clicking on the environment name (or on the "Services" button) and then, click
the
<filename>"Add Application"</filename>button.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/Environments/add-app-btn.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>
After clicking on the button you will be redirected to the "Application Catalog" page.
Here you can see all applications: public applications and application uploaded by yourself.
(Information about how to upload your own package to repository is availiable in appropriate chapter.)
You have an opportunity to add some of them. Base public applications are following:
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/Application_Catalog/AppCatalog.png" scalefit="1" width="100%" contentdepth="50%" />
</imageobject>
</mediaobject>
<para>
Once you choose application that you want to add click "Add to Env" and fill the form.
Forms for each application are specific.
To see more information about filling the form for a specific application follow one of the link below:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">
<link linkend="ASP">ASP.NET Service:</link>
</emphasis>
is a server-side Web application framework designed for Web
development to produce dynamic Web pages. Service is able
to install custom application onto one IIS Web Server. Murano installs
all needed components and makes proper configuration.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">
<link linkend="ASPfarm">ASP.NET Farm Service:</link>
</emphasis>
ASP.NET Farm Service installs a custom application on a
load-balanced array of IIS servers.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold"><link linkend="AD">Active Directory:</link></emphasis>
Active Directory is a directory service implemented by Microsoft for Windows domain networks.
In one installation, in addition to primary Domain Controller,
you can add optional count of secondary Domain Controllers.
Any other services you are intending to create can be
joined to that domain.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">
<link linkend="Apache">Apache Service:</link></emphasis>
Apache HTTP Server is a web server application notable for playing a key role in the initial growth of the World Wide Web.
This service can install Apache with PHP module or without it.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">
<link linkend="Tomcat">Apache Tomcat:</link></emphasis>
Apache Tomcat is an open source software implementation of the Java Servlet and JavaServer Pages technologies.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">
<link linkend="Demo">Demo Service:</link></emphasis>
Installs test service that demonstrates how to Murano interconnects with Murano Demo Agent.
For this service light-weight Linux Cirros image can be used.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">
<link linkend="IIS">Internet Information Service:</link></emphasis>
IIS is a web server and a set of feature extension modules.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">
<link linkend="IISfarm">Internet Information Web Farm Service:</link>
</emphasis>
Murano installs the Web Farm Framework on the controller server,
configures the primary server and prepares the secondary servers.
In addition load balancer is installed to monitor service statuses.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold"><link linkend="Telnet">Linux Telnet:</link></emphasis>
Telnet - is a network protocol used to provide a bidirectional interactive
text-oriented communication facility using a virtual terminal connection.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold"><link linkend="SQL">MS SQL Service:</link></emphasis>
Microsoft SQL Service is a relational database management system.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">
<link linkend="SQLfarm">MS SQL Server Failover Cluster:</link>
</emphasis>
Murano installs all needed components and configures your
SQL Server Cluster the way you want.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">
<link linkend="PostgreSQL">PostgreSQL:</link>
</emphasis>
PostgreSQL, often simply "Postgres", is an object-relational database management
system with an emphasis on extensibility and standards-compliance.
</para>
</listitem>
</itemizedlist>
<para>
On the last step of creating application prototype you have opportunity to set
the hardware flavor of the instance which will be created -
and the image with the operating system, which will be installed on
the instance. Also you may select availability zone, if there are more
then one in your environment.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/last_step.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<section xml:id="AD">
<title>Active Directory</title>
<para>
After you picked the Active Directory service in service creation
wizard you'll see the following form:
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/active_directory.png" width="100%" contentdepth="100%" format="PDF" />
</imageobject>
</mediaobject>
<para>
Enter or select values for this fields:
</para>
<informaltable rules="all" frame="border"
width="100%" cellpadding="3" cellspacing="3">
<col width="25%" align="left" style="font-weight:bold" valign="top"/>
<col width="70%" style="padding:6px"/>
<tbody>
<tr>
<td style="font-weight:bold">
<para>Domain name</para>
</td>
<td >
<para>
Enter a desired name for a new domain. This name should fit to
DNS Domain Name requirements: it should contain
only A-Z, a-z, 0-9, (.) and (-) and should not end with a dash.
DNS server will be automatically set up on each of the Domain
Controller instances.
Period characters are allowed only when they
are used to delimit the components of domain style
names. Single-level domain is not appropriate.
Note: Only first 15 characters or characters
before first period is used as NetBIOS name.
</para>
</td>
</tr>
<tr>
<td><para>Instance Count</para></td>
<td>
<para>
You can create several Active Directory instances by setting
instance number larger than one. One primary
Domain Controller and a few secondary DCs will be created.
</para>
</td>
</tr>
<tr>
<td><para>Account Name</para></td>
<td >
<para>
You account will have Active Directory administrator rights.
So initial value is "Administrator" but you can change it to any name you like.
</para>
</td>
</tr>
<tr>
<td><para>Administrator password</para></td>
<td>
<para>
Windows requires strong password for service administration.
Your password should have at least one letter
in each
register, a number and a special character.
Password length should be
a minimum of 7 characters.
Once you forget your password you won't be able
to
operate the service until recovery password
would be entered. So it's
better for Recovery and Administrator password
to be different.
</para>
</td>
</tr>
<tr>
<td><para>Confirm password</para></td>
<td>
<para>Password confirmation is required.</para>
</td>
</tr>
<tr>
<td><para>Recovery password</para></td>
<td>
<para>
Restrictions are the same as for the Administrator password.
Please provide password that is different from Administrator.
It's not required for form validation though.
</para>
</td>
</tr>
<tr>
<td><para>Confirm password</para></td>
<td>
<para>Password confirmation is required.</para>
</td>
</tr>
</tbody>
</informaltable>
</section>
<section xml:id="IIS">
<title>Internet Information Service</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/iis.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</section>
<section xml:id="IISfarm">
<title>Internet Information Web Farm Service</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/iis_farm.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</section>
<section xml:id="ASP">
<title>ASP.NET Service</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/asp_net.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</section>
<section xml:id="ASPfarm">
<title>ASP.NET Farm Service</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/asp_net_farm.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</section>
<section xml:id="SQL">
<title>MS SQL Service</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/sql.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</section>
<section xml:id="SQLfarm">
<title>MS SQL Server Failover Cluster</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/cluster1.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>Enter or select values for the following fields:</para>
<informaltable rules="all" frame="border" width="100%" cellpadding="3"
cellspacing="3">
<col width="25%" align="left" style="font-weight:bold"
valign="top"/>
<col width="70%" style="padding:6px"/>
<tbody>
<tr>
<td style="font-weight:bold">
<para>Service Name</para>
</td>
<td>
<para>
Enter a desired name for a service. Just A-Z,
a-z, 0-9, dash and underline are allowed.
</para>
</td>
</tr>
<tr>
<td>
<para>Administrator password</para>
</td>
<td>
<para>
Windows requires strong password for service
administration.
Your password should have at least one letter
in each register, a number and a special character.
Password length should be a minimum of 7 characters.
</para>
</td>
</tr>
<tr>
<td>
<para>Confirm password</para>
</td>
<td>
<para>Password confirmation is required.</para>
</td>
</tr>
<tr>
<td>
<para>Active Directory is configured by the System Administrator
</para>
</td>
<td>
<para>
Enable this option only if you have properly configured rules
that will include service to the domain, that already exists in you environment.
Once you set this option to true, additional fields will appear. (See information below)
</para>
</td>
</tr>
<tr>
<td>
<para>Domain</para>
</td>
<td>
<para>
Service should be joined to the Active
Directory
domain. Please, create Active Directory Service
prototype first.
</para>
</td>
</tr>
<tr>
<td>
<para>Mixed-mode Authentication</para>
</td>
<td>
<para>
Mixed authentication mode allows the use of Windows
credentials but supplements them with local SQL
Server user accounts that the administrator may create and
maintain within SQL Server. If this mode is on SA password is required
</para>
</td>
</tr>
<tr>
<td>
<para>SA Password</para>
</td>
<td>
<para>
Set system administrator password for the MS SQL Server.
Password requirements are the same as previous.
</para>
</td>
</tr>
</tbody>
</informaltable>
<para>
In case pre-configured AD is enabled following fields will appeared:
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/cluster1a.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<informaltable rules="all" frame="border" width="100%" cellpadding="3"
cellspacing="3">
<col width="25%" align="left" style="font-weight:bold"
valign="top"/>
<col width="70%" style="padding:6px"/>
<tbody>
<tr>
<td style="font-weight:bold">
<para>Active Directory User</para>
<para>Active Directory Password</para>
</td>
<td>
<para>
Specify administrator user credentials to the existent AD domain
(to which service service will be join according to your system automation setup)
</para>
</td>
</tr>
</tbody>
</informaltable>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/cluster2.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/cluster3.png" scalefit="1"
width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</section>
<section xml:id="Apache">
<title>Linux Apache Service</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/apache.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<informaltable rules="all" frame="border" width="100%" cellpadding="3"
cellspacing="3">
<col width="25%" align="left" style="font-weight:bold"
valign="top"/>
<col width="70%" style="padding:6px"/>
<tbody>
<tr>
<td style="font-weight:bold">
<para>Service Name</para>
</td>
<td>
<para>
Enter a desired name for a service. Just A-Z,
a-z, 0-9, dash and underline are allowed.
</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>PHP module</para>
</td>
<td>
<para>
PHP module can be installed with Apache.
Enable or disable this options via checkbox.
</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>Key Pair</para>
</td>
<td>
<para>
Select SSH Key Pair from the existing to
control access to your instance.
</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>Hostname</para>
</td>
<td>
<para>
Machine hostname.
If blank - random name will be used.
</para>
</td>
</tr>
</tbody>
</informaltable>
</section>
<section xml:id="Telnet">
<title>Linux Telnet Service</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/telnet.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<informaltable rules="all" frame="border" width="100%" cellpadding="3"
cellspacing="3">
<col width="25%" align="left" style="font-weight:bold"
valign="top"/>
<col width="70%" style="padding:6px"/>
<tbody>
<tr>
<td style="font-weight:bold">
<para>Service Name</para>
</td>
<td>
<para>
Enter a desired name for a service. Just A-Z,
a-z, 0-9, dash and underline are allowed.
</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>Key Pair</para>
</td>
<td>
<para>
Select SSH Key Pair from the existing.
</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>Hostname</para>
</td>
<td>
<para>
Machine hostname.
If blank - random name will be used.
</para>
</td>
</tr>
</tbody>
</informaltable>
</section>
</section>
<section>
<title>Deploying environment</title>
<para>
Once all application are added you can send environment to deploy.
Just press the <filename>"Deploy This Environment"</filename> button.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/Environments/deploy-env-btn.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>
And you'll see a message about successful start of deploying your services in Openstack. Since now all you have to do is just wait for a little bit
while Murano installing and configuring your services.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/Environments/deploy_started.png" scalefit="1"
width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>
You can monitor deploying process. Just go to the Log tab on service
detailed page, where you can get by clicking on the service name.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/service_name.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>
And now you can see installation progress.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/logs.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>
As long as installation and configuration are in progress, environment
is in <emphasis>Deploy in progress</emphasis> state. Depending on how many
applications you are deploying or how many nodes in your cluster, process of spawning instances,
installation and post installation settings takes from 10 minutes up to one hour.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/Environments/deploy-in-prg.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>
If installation process finished without any errors, environment changes its status to
<emphasis>Ready:</emphasis>
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/done.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</section>
<section>
<title>Working with deployed environment</title>
<para>
Congratulations! After some time waiting you are able to operate with the applications.
To get information about installed application, navigate to service detailed page.
To do that click on the environment name and then on the name of the service you what to know about.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/iis_farm_detail.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>
Now you are seeing general information about the service in terms of Murano Environment.
To get information about the instance in Openstack terms follow the link on service instance name.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/name_link.png" scalefit="1"/>
</imageobject>
</mediaobject>
<para>
You can login to the virtual machine directly from the horizon (if your Openstack installation allows you) or by RDP protocol.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/instance_console.png" scalefit="1"
width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>There are more things you can do with Murano Environment:</para>
<itemizedlist>
<listitem>
<para><link linkend="redeploy">Add new application and deploy it again;</link></para>
</listitem>
<listitem>
<para><link linkend="delete">Delete outdated and unnecessary environments or applications;</link></para>
</listitem>
<listitem>
<para><link linkend="deployments">Browse deployment history and application installation logs;</link></para>
</listitem>
<listitem>
<para><link linkend="edit">Rename your environment.</link></para>
</listitem>
</itemizedlist>
<section xml:id="redeploy">
<title>Redeploying Murano Environment</title>
<para>
Murano gives an opportunity to supplement already deployed environment.
Thus if you already deployed the Active Directory service and want to add
any other services just create desired service prototype and click the "Deploy This Environment" button.
During service prototype creation you can join this service to the existent Active Directory domain.
</para>
</section>
<section xml:id="delete">
<title>Deleting</title>
<para>Applications as well as environments can be easily deleted.</para>
<itemizedlist>
<listitem>
<para>To delete an environment go to the Deployment > Environments index page and click "More" -> "Delete Environment" in Actions column of ready to delete environment.</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/Environments/delete-env.png"
scalefit="1" width="100%"
contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>
Environment deletion means to kill all services with instances on which they are installed.
Instances will be scheduled to delete right after you choose the "Delete Environment" action.
</para>
</listitem>
<listitem>
<para>
To delete an application go to the application list page and click the "Delete Service" button in Actions column. <emphasis role="bold">Note:</emphasis>
If you are deleting application that was already deployed you'll need to <emphasis>Deploy</emphasis> the environment again by pressing corresponding button.
In case you want to delete application prototype - it has <emphasis>"Service draft created"</emphasis> in the <emphasis>
Last operation</emphasis> column (see the screenshot below) - changes applies right away.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/service_delete.png"
scalefit="1" width="100%"
contentdepth="100%"/>
</imageobject>
</mediaobject>
</listitem>
</itemizedlist>
</section>
<section xml:id="deployments">
<title>Browsing Murano Deployment</title>
<para>
Since Murano Environment can be deployed many times you may want
to see the history of its deployments. To do that click the "More-> Show deployments"
button on environments index page:
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/Environments/show-env.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>
From this page it's easy to see how many times and when Murano Environment was deployed:
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/deployments.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>
For each deployment you can get a detailed information by clicking the "Show Details" button.
You always can go back to any level using navigation string at the page header.
From here you can observe what services were installed during deployment:
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/deployment_configuration.png"
scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>Also deployment logs are available at the "Logs" tab:</para>
<mediaobject>
<imageobject role="fo">
<imagedata
fileref="../images/deployment_logs.png"
scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</section>
<section xml:id="edit">
<title>Renaming Murano Environment</title>
<para>
It's possible to change a name of your environment: just click the "More-> Edit Environment" button on environment index page:
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/Environments/edit-env.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>
Environment name is not involved in application creation process but environment name have to corresponds with
heat stack name. So name must contains only alphanumeric characters (case sensitive) and start with an alpha character.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/Environments/rename-env.png" scalefit="1"
width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</section>
</section>
<section xml:id="trouble">
<title>Troubleshooting</title>
<para><emphasis role="bold"> How to debug OpenStack Heat?</emphasis></para>
<para>
If you can execute Heat command via console interface - all good. It is
the most simple way to check Heat state on the node - just execute CLI
command 'heat list'.
See more information about Heat in openstack wiki
<link xlink:href="https://wiki.openstack.org/wiki/Heat/TroubleShooting"> page</link>
</para>
<para><emphasis role="bold"> If 'heat list' returns 503 error</emphasis></para>
<para>
It means that OpenStack Heat configuration files contain incorrect
credentials. Need to set 'user' = 'heat' and change passwords
'verybadpass' in all configuration files from directory /etc/heat/
</para>
<para><emphasis role="bold">If 'heat list' hangs up</emphasis></para>
<para>
Sometimes you can see that 'heat list' hangs up. The root of this
problem - connection to the rabbitMQ.
</para>
<para><emphasis role="bold">How I can connect to LoadBalancer instance in Server Farms?</emphasis></para>
<para>
First of all you should have KeyPair file 'murano-lb-key'. You can
create this file using commands
<programlisting>
<![CDATA[
nova keypair-add murano-lb-key > murano-lb-key.priv
chmod 600 murano-lb-key.priv
]]>
</programlisting>
And after that server farms need to be created with this KeyPair.
The second step is to 'how to connect to VM with LoadBalancer':
<programlisting>
<![CDATA[
ssh -i murano-lb-key.priv root@10.0.0.3
]]>
</programlisting>
</para>
<para><emphasis role="bold">Murano dashboard can not connect to Murano API. How I can fix it?</emphasis></para>
<para>
This problem has two ways to fix:
Add string
<programlisting>
<![CDATA[
MURANO_API_URL='http://localhost:8082'
]]>
</programlisting>
to the /etc/openstack-dashboard/local_settings (or
/etc/openstack-dashboard/local_settings.py - it depends on OpenStack
configuration)
and after that web server restart is needed.
Add keystone endpoints for Murano API
<programlisting>
<![CDATA[
keystone service-create --name muranoapi --type murano --description "Murano-Api Service"
keystone endpoint-create --region RegionOne --service-id
--publicurl http://localhost:8082 --internalurl http://localhost:8082 --adminurl http://localhost:8082
]]>
</programlisting>
</para>
<para><emphasis role="bold">
Murano API Service does not work on CentOS 6.x. WebUI can not connect
to this service. How to fix this?</emphasis>
</para>
<para>
The problem in pip lib routes. Need to upgrade this lib and restart
Murano API:
<programlisting>
<![CDATA[
python-pip install routes --upgrade
initctl stop murano-api
initctl start murano-api
]]>
</programlisting>
</para>
<para><emphasis role="bold">
Error 'Unexpected state' during the deployment of Web Farms. What the
problem? </emphasis>
</para>
<para>
Sometimes we can see in deployments logs:
<programlisting>
<![CDATA[
2013-08-06 09:10:07 - Unable to deploy instance ipkrmhk0vzq4b6 (asp-farm_instance_0) due to Unexpected state
2013-08-06 09:10:07 - Unable to create a Server Farm load balancer on unit ipkrmhk0vzq4b6 (asp-farm_instance_0) due to Unexpected state
]]>
</programlisting>
The root of this problem is incorrect configuration - Heat can not
create Load Balancer instance. Please, remember that you should have
admin access for the project in OpenStack to deploy LoadBalancer and also,
you should have KeyPair with default name 'murano-lb-key'.
</para>
<para><emphasis role="bold">Error in Murano API logs 'No module named helpers.token_sanitizer'</emphasis></para>
<para>
This pip version problem. Need to install pip 1.4 and after that reinstall murano-client, murano-common and murano-api.
</para>
</section>
</chapter>

266
src/user-guide/src/docbkx/content/management.xml Normal file
View File

@ -0,0 +1,266 @@
<?xml version='1.0' encoding='UTF-8'?>
<!--
Copyright (c) 2013 Mirantis, Inc. Licensed under the Apache License,
Version 2.0 (the &quot;License&quot;); you may not use this file
except in compliance with the License. You may obtain a copy of the
License at http://www.apache.org/licenses/LICENSE-2.0 Unless required
by applicable law or agreed to in writing, software distributed under
the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
the License for the specific language governing permissions and
limitations under the License.
-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
version="5.0"
xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd">
<title>Murano Management</title>
<section xml:id="PackageDefinition">
<title>Package definitions</title>
<para>
Cloud administrator has rights to manage applications in the
catalog: upload new applications, modify existing, disable or
delete them.
All this actions are available in Murano UI and will be described
in this section. Go to the <emphasis>Manage ->Package
Definitions</emphasis> page.
<mediaobject>
<imageobject role="fo">
<imagedata contentdepth="100%"
fileref="../images/manage/index.png"
scalefit="1" width="100%"/>
</imageobject>
</mediaobject>
<itemizedlist>
<listitem>
<para>
<filename>Upload Package</filename>
provides a form for uploading an application package.
After this operation your application will be
acceptable from application catalog.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata contentdepth="100%"
fileref="../images/manage/upload.png"
scalefit="1" width="100%"/>
</imageobject>
</mediaobject>
<para>
You'll need to provide path to the package with your
application. It should be in a zip format.
See
<link xlink:href="https://wiki.openstack.org/wiki/Murano/Documentation/How_to_create_application_package">
here
</link>
for more information on how to prepare an application
package. Also select one category to which your application belongs too.
</para>
</listitem>
<listitem>
<para>
<filename>Toggle Active</filename>
makes an application
active or disabled depending on the current state.
</para>
</listitem>
<listitem>
<para>
<filename>Delete Packages</filename>
removes applications from the catalog
</para>
</listitem>
<listitem>
<para>
<filename>Modify Package</filename>
gives you opportunity to modify meta information about
the application.
</para>
<mediaobject>
<imageobject role="fo">
<imagedata contentdepth="100%"
fileref="../images/manage/modify.png"
scalefit="1" width="100%"/>
</imageobject>
</mediaobject>
<para>The following properties are allowed to edit:
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Name</emphasis>
- visible application name
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Categories</emphasis>
- change application category
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Tags</emphasis>
- specify comma-separated list of words,
associated with the application
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Public</emphasis>
- indicates access for non-admin users from
all tenants
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Active</emphasis>
- indicates if this application is enabled
or disabled
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Description
</emphasis>
- extend information about application,
which will be shown at the Application
Details page
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>
<filename>Download Package</filename>
saves application definition as zip archive, as it was
uploaded
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Murano Images</title>
<para>
Murano uses preconfigured images for spawning instances. Image
suitable for Murano should have Murano Agent installed at least.
See
<link xlink:href="http://murano-docs.github.io/latest/administrators-guide/content/ch03.html">
here
</link>
how to build Murano images and upload it to Glance. Since Murano
supports different operating systems it&apos;s not possible to use
one image to build every single application. To classify images
Metadata property of Glance image is used. Murano Dashboard allows
to
add that property from a separate view. Navigate to the Murano tab
and go to
<filename>Images</filename>
panel.
<warning>
<para>To operate with Glance Images you need to have admin
rights!
</para>
</warning>
<mediaobject>
<imageobject role="fo">
<imagedata contentdepth="100%"
fileref="../images/images/index.png"
scalefit="1" width="100%"/>
</imageobject>
</mediaobject>
You are browsing Glance images with correctly set
&quot;murano_image_info&quot; property - image metadata. From this
view you are able to:
<itemizedlist>
<listitem>
<para>Delete an existing image metadata with
<filename>&quot;Delete
Metadata&quot;</filename>
button (only image's property get deleted,
the image itself stays in Glance)
</para>
</listitem>
<listitem>
<para>Add new murano metadata to an image that is already
registered in Glance by clicking on
<filename>&quot;Mark Image&quot;</filename> button
</para>
</listitem>
</itemizedlist>
Take a look at the &quot;Mark Image&quot; form:
</para>
<para>
<mediaobject>
<imageobject role="fo">
<imagedata contentdepth="100%"
fileref="../images/images/mark_image.png"
scalefit="1" width="100%"/>
</imageobject>
</mediaobject>
<informaltable cellpadding="3" cellspacing="3" frame="border"
rules="all" width="100%">
<col align="left" style="font-weight:bold" valign="top"
width="25%"/>
<col style="padding:6px" width="70%"/>
<tbody>
<tr>
<td style="font-weight:bold">
<para>Image</para>
</td>
<td>
<para>From all images registered in Glance pick one
that was created with
<link linked="http://murano-docs.github.io/latest/administrators-guide/content/ch03.html">
Murano Image Builder</link>.
</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>Title</para>
</td>
<td>
<para>Set name for a selected image to recognize it
easier during
service creation.
</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>Type</para>
</td>
<td>
<para>
For now there are three supported types:
<itemizedlist>
<listitem>
<para>Windows Server 2012 - used to
build Windows-based
applications
</para>
</listitem>
<listitem>
<para>Murano Demo - light-weight Linux
Cirros image with
Murano Demo Agent
</para>
</listitem>
<listitem>
<para>Generic Linux - used to build
Linux-based
applications
</para>
</listitem>
</itemizedlist>
</para>
</td>
</tr>
</tbody>
</informaltable>
</para>
</section>
</chapter>

208
src/user-guide/src/docbkx/content/metadata.xml
View File

@ -1,208 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<!--
Copyright (c) 2013 Mirantis, Inc. Licensed under the Apache License,
Version 2.0 (the &amp;quot;License&amp;quot;); you may not use this
file except in compliance with the License. You may obtain a copy of
the License at http://www.apache.org/licenses/LICENSE-2.0 Unless
required by applicable law or agreed to in writing, software
distributed under the License is distributed on an &amp;quot;AS
IS&amp;quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
either express or implied. See the License for the specific language
governing permissions and limitations under the License.
-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
version="5.0" xsi:schemaLocation="http://docbook.org/ns/docbook
http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd">
<title>Metadata Repository</title>
<para>This chapter describes how to operate with Murano Metadata
Repository via UI. </para>
<para>
Metadata Repository is a REST API server stores all data
necessary for a service deployment. Information about service and
it&apos;s dependencies is called <emphasis>service definition</emphasis>
or <emphasis>manifest</emphasis>. Murano Conductor and Dashboard will
load these service definitions and service or application will be available
for creation. Besides manifests Murano Repository stores this types
of data:
<itemizedlist>
<listitem>
<para><emphasis>ui</emphasis> - UI definitions for Murano
dashboard</para>
</listitem>
<listitem>
<para><emphasis>workflows</emphasis> - set of rules for Murano
Conductor</para>
</listitem>
<listitem>
<para><emphasis>heat</emphasis> - templates for spawning instance
with Heat</para>
</listitem>
<listitem>
<para><emphasis>agent</emphasis> - Murano Agent templates</para>
</listitem>
<listitem>
<para><emphasis>scripts</emphasis> - Murano Execution Plans</para>
</listitem>
</itemizedlist>
In &quot;Murano&quot; tab go to the <filename>"Service Definitions"</filename> panel:
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Metadata/index.png" scalefit="1" width="100%"/>
</imageobject></mediaobject>
</para>
<para>
From this view you are able to perform the following actions:
<itemizedlist>
<listitem>
<para><filename>Compose Service</filename> provides a form for
creating new service manifest. After this operation is complete new service
will appear in Service Definitions table and you will be allowed
to download this service definition, modify or delete it.</para>
</listitem>
<listitem>
<para><filename>Upload Service</filename> provides a form for
uploading tar.gz archive with already composed service manifest and
other dependency files.</para>
</listitem>
<listitem>
<para><filename>Manage Files</filename> button will redirect you to
a view where you can manipulate with all files stored in Metadata
Repository: download, delete or upload new ones.</para>
</listitem>
<listitem>
<para><filename>Toggle Active</filename> button will make service
active or inactive depending on the current state.</para>
</listitem>
<listitem>
<para><filename>Modify Service</filename> gives you opportunity to
modify attributes of service definition.</para>
</listitem>
<listitem>
<para><filename>Manage Service</filename> redirects you to a view
with information about selected service and service files for all
data types that Murano Repository supports. From here you can
upload file and add it to service dependency in one click.</para>
</listitem>
<listitem>
<para><filename>Download Service</filename> saves archive with all
files used by specified service.</para>
</listitem>
<listitem>
<para><filename>Delete Service</filename> removes service manifest
and all dependencies that are not used by other services from
Murano Repository server.</para>
<para/>
</listitem>
</itemizedlist>
</para>
<section>
<title>
Compose Service
</title>
<para>
Let's review service creation in details.
After clicking on "Compose Service" button from "Service Definitions" view you'll see the following form:
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Metadata/compose_service1.png" scalefit="1" width="100%"/>
</imageobject></mediaobject>
It consists of several tabs. On the first tab you need to fill up general information about service.
On the next tab select one of the UI definitions you want to use for this service.
You can upload new definition in the <emphasis><link linked="manage_files">Manage Files</link></emphasis> view.
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Metadata/compose_service2.png" scalefit="1" width="100%"/>
</imageobject></mediaobject>
All other tabs correspond to data types. Navigate to desired tab and select files for service dependency.
The only mandatory requirement for a new service is a UI definition file - if a service doesn't reference any, it won't be shown in the
<filename>"Create Service"</filename> form. All other tabs refer to a files required for a service's deployment phase.
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Metadata/compose_service3.png" scalefit="1" width="100%"/>
</imageobject></mediaobject>
</para>
</section>
<section xml:id="manage_files">
<title>Manage Files</title>
<para>
Murano Repository table shows all files stored in Metadata
Repository. Files are divided into categories by data types.
Button name of each category also contains the number of files in that category.
Click on the type name to browse all files of this type.
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Metadata/manage_files.png " scalefit="1" width="100%"/>
</imageobject></mediaobject>
The following actions are available:
<itemizedlist>
<listitem>
<para>Download file,</para>
</listitem>
<listitem>
<para>Delete file,</para>
</listitem>
<listitem>
<para>Upload file.</para>
</listitem>
</itemizedlist>
To upload file to repository you need to fill up this form:
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Metadata/manage_files_upload.png" scalefit="1" width="100%"/>
</imageobject></mediaobject>
<informaltable cellpadding="3" cellspacing="3" frame="border" rules="all" width="100%">
<col align="left" style="font-weight:bold" valign="top" width="25%"/>
<col style="padding:6px" width="70%"/>
<tbody>
<tr>
<td style="font-weight:bold">
<para>Murano Repository File</para>
</td>
<td>
<para>Select file for uploading. It should be not bigger than 5Mb.</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>File Type</para>
</td>
<td>
<para>
Select one of supported type. It will be loaded directly to a directory that stores corresponding file types.
</para>
</td>
</tr>
</tbody>
</informaltable>
</para>
</section>
<section>
<title>
Manage Service
</title>
<para>
Manage Service view displays general information about service and list of file dependency grouped by a separate tables.
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Metadata/manage_service.png" scalefit="1" width="100%"/>
</imageobject></mediaobject>
In the following view these actions are available:
<itemizedlist>
<listitem>
<para>
View service detail information.
</para>
</listitem>
<listitem>
<para>
Download File.
</para>
</listitem>
<listitem>
Delete file.
</listitem>
<listitem>
<para>
Upload file of the exact type by pressing the &#60;File type&#62;" button in the appropriate table.
</para>
</listitem>
</itemizedlist>
</para>
</section>
</chapter>

38
src/user-guide/src/docbkx/content/overview.xml
View File

@ -21,14 +21,16 @@
xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd" http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd"
version="5.0"> version="5.0">
<title>How can I use Murano Service?</title> <title>Overview</title>
<para> <para>
Murano is intended to get opportunity for non-experienced Murano is an Application catalog for Openstack.
users to deploy different kinds of applications extremely simple. Full information about Murano in <link xlink:href="https://wiki.openstack.org/wiki/Murano">Openstack wiki page.</link>
To use Murano you should be familiar with Openstack. Murano Project introduces an application catalog, which allows application developers and cloud administrators to publish various cloud-ready applications
Murano Dashboard is just a plugin to Openstack dashboard - Horizon. in a browsable categorised catalog.
Please visit horizon user guide first to see how dashboard is organized and how to login into it. It may be used by the cloud users to pick-up the needed applications and services and composes the reliable environments out of them in a “push-the-button” manner.
This document describes Murano Dashboard usage in detail. Murano UI is just a plugin to Openstack dashboard - Horizon.
Please visit horizon user guide first to see how dashboard is organized and how to log in to it.
This document describes Murano Application Catalog usage in detail.
</para> </para>
<section> <section>
<title>Document change history</title> <title>Document change history</title>
@ -36,7 +38,7 @@
<informaltable rules="all"> <informaltable rules="all">
<tgroup cols='2'> <tgroup cols='2'>
<colspec colname="col1" colnum="1" colwidth="1*"/> <colspec colname="col1" colnum="1" colwidth="1*"/>
<colspec colname="col2" colnum="2" colwidth="1*"/> <colspec colname="col2" colnum="2" />
<thead> <thead>
<row> <row>
<entry>Revision Date</entry> <entry>Revision Date</entry>
@ -46,10 +48,10 @@
<tbody> <tbody>
<row> <row>
<entry> <entry>
September. 4, 2013 September 4, 2013
</entry> </entry>
<entry> <entry>
<itemizedlist spacing="compact"> <itemizedlist>
<listitem> <listitem>
<para>Update for Release-0.2</para> <para>Update for Release-0.2</para>
</listitem> </listitem>
@ -58,16 +60,28 @@
</row> </row>
<row> <row>
<entry> <entry>
December. 9, 2013 December 9, 2013
</entry> </entry>
<entry> <entry>
<itemizedlist spacing="compact"> <itemizedlist>
<listitem> <listitem>
<para>Update for Release-0.4</para> <para>Update for Release-0.4</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</entry> </entry>
</row> </row>
<row>
<entry>
April 22, 2014
</entry>
<entry>
<itemizedlist>
<listitem>
<para>Update for Release-0.5</para>
</listitem>
</itemizedlist>
</entry>
</row>
</tbody> </tbody>
</tgroup> </tgroup>
</informaltable> </informaltable>

118
src/user-guide/src/docbkx/content/troubleshooting.xml Normal file
View File

@ -0,0 +1,118 @@
<?xml version='1.0' encoding='UTF-8'?>
<!--
Copyright (c) 2013 Mirantis, Inc. Licensed under the Apache License,
Version 2.0 (the &quot;License&quot;); you may not use this file
except in compliance with the License. You may obtain a copy of the
License at http://www.apache.org/licenses/LICENSE-2.0 Unless required
by applicable law or agreed to in writing, software distributed under
the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
the License for the specific language governing permissions and
limitations under the License.
-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
version="5.0"
xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd">
<title>Troubleshooting</title>
<section xml:id="trouble">
<title>FQN</title>
<para><emphasis role="bold"> How to debug OpenStack Heat?</emphasis></para>
<para>
If you can execute Heat command via console interface - all good. It is
the most simple way to check Heat state on the node - just execute CLI
command 'heat list'.
See more information about Heat in openstack wiki
<link xlink:href="https://wiki.openstack.org/wiki/Heat/TroubleShooting"> page</link>
</para>
<para><emphasis role="bold"> If 'heat list' returns 503 error</emphasis></para>
<para>
It means that OpenStack Heat configuration files contain incorrect
credentials. Need to set 'user' = 'heat' and change passwords
'verybadpass' in all configuration files from directory /etc/heat/
</para>
<para><emphasis role="bold">If 'heat list' hangs up</emphasis></para>
<para>
Sometimes you can see that 'heat list' hangs up. The root of this
problem - connection to the rabbitMQ.
</para>
<para><emphasis role="bold">How I can connect to LoadBalancer instance in Server Farms?</emphasis></para>
<para>
First of all you should have KeyPair file 'murano-lb-key'. You can
create this file using commands
<programlisting>
<![CDATA[
nova keypair-add murano-lb-key > murano-lb-key.priv
chmod 600 murano-lb-key.priv
]]>
</programlisting>
And after that server farms need to be created with this KeyPair.
The second step is to 'how to connect to VM with LoadBalancer':
<programlisting>
<![CDATA[
ssh -i murano-lb-key.priv root@10.0.0.3
]]>
</programlisting>
</para>
<para><emphasis role="bold">Murano dashboard can not connect to Murano API. How I can fix it?</emphasis></para>
<para>
This problem has two ways to fix:
Add string
<programlisting>
<![CDATA[
MURANO_API_URL='http://localhost:8082'
]]>
</programlisting>
to the /etc/openstack-dashboard/local_settings (or
/etc/openstack-dashboard/local_settings.py - it depends on OpenStack
configuration)
and after that web server restart is needed.
Add keystone endpoints for Murano API
<programlisting>
<![CDATA[
keystone service-create --name muranoapi --type murano --description "Murano-Api Service"
keystone endpoint-create --region RegionOne --service-id
--publicurl http://localhost:8082 --internalurl http://localhost:8082 --adminurl http://localhost:8082
]]>
</programlisting>
</para>
<para><emphasis role="bold">
Murano API Service does not work on CentOS 6.x. WebUI can not connect
to this service. How to fix this?</emphasis>
</para>
<para>
The problem in pip lib routes. Need to upgrade this lib and restart
Murano API:
<programlisting>
<![CDATA[
python-pip install routes --upgrade
initctl stop murano-api
initctl start murano-api
]]>
</programlisting>
</para>
<para><emphasis role="bold">
Error 'Unexpected state' during the deployment of Web Farms. What the
problem? </emphasis>
</para>
<para>
Sometimes we can see in deployments logs:
<programlisting>
<![CDATA[
2013-08-06 09:10:07 - Unable to deploy instance ipkrmhk0vzq4b6 (asp-farm_instance_0) due to Unexpected state
2013-08-06 09:10:07 - Unable to create a Server Farm load balancer on unit ipkrmhk0vzq4b6 (asp-farm_instance_0) due to Unexpected state
]]>
</programlisting>
The root of this problem is incorrect configuration - Heat can not
create Load Balancer instance. Please, remember that you should have
admin access for the project in OpenStack to deploy LoadBalancer and also,
you should have KeyPair with default name 'murano-lb-key'.
</para>
<para><emphasis role="bold">Error in Murano API logs 'No module named helpers.token_sanitizer'</emphasis></para>
<para>
This pip version problem. Need to install pip 1.4 and after that reinstall murano-client, murano-common and murano-api.
</para>
</section>
</chapter>

BIN
src/user-guide/src/docbkx/images/Application_Catalog/AppCatalog.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 90 KiB

BIN
src/user-guide/src/docbkx/images/Environments/add-app-btn.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 46 KiB

BIN
src/user-guide/src/docbkx/images/Environments/create-env.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 39 KiB

BIN
src/user-guide/src/docbkx/images/Environments/created-env.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 59 KiB

BIN
src/user-guide/src/docbkx/images/Environments/deploy-env-btn.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 64 KiB

BIN
src/user-guide/src/docbkx/images/Environments/deploy-in-prg.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 40 KiB

BIN
src/user-guide/src/docbkx/images/Environments/main-envs.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 41 KiB

BIN
src/user-guide/src/docbkx/images/Environments/show-env.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 47 KiB

BIN
src/user-guide/src/docbkx/images/Images/Image 13.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 33 KiB

BIN
src/user-guide/src/docbkx/images/Images/main-images.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 89 KiB

BIN
src/user-guide/src/docbkx/images/Images/mark_image.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 18 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/compose_service1.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 20 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/compose_service2.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 23 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/compose_service3.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 20 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/index.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 71 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/manage_files.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 67 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/manage_files_upload.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 25 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/manage_service.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 92 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/upload_tofile.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 9.7 KiB

BIN
src/user-guide/src/docbkx/images/app_catalog/category_selector.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
src/user-guide/src/docbkx/images/app_catalog/details.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 16 KiB

BIN
src/user-guide/src/docbkx/images/app_catalog/details2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 52 KiB

BIN
src/user-guide/src/docbkx/images/app_catalog/env_selector.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 58 KiB

BIN
src/user-guide/src/docbkx/images/app_catalog/index.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 84 KiB

BIN
src/user-guide/src/docbkx/images/app_catalog/search.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 64 KiB

BIN
src/user-guide/src/docbkx/images/deploy_started.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 39 KiB

BIN
src/user-guide/src/docbkx/images/environments/add-app-btn.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 45 KiB

BIN
src/user-guide/src/docbkx/images/environments/create-env.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

BIN
src/user-guide/src/docbkx/images/environments/created.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 54 KiB

0
src/user-guide/src/docbkx/images/Environments/delete-env.png → src/user-guide/src/docbkx/images/environments/delete-env.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 47 KiB

BIN
src/user-guide/src/docbkx/images/environments/deploy-env-btn.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 61 KiB

BIN
src/user-guide/src/docbkx/images/environments/deploy-in-prg.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB

BIN
src/user-guide/src/docbkx/images/environments/deploy_started.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB

0
src/user-guide/src/docbkx/images/Environments/edit-env.png → src/user-guide/src/docbkx/images/environments/edit-env.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

BIN
src/user-guide/src/docbkx/images/environments/logs.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
src/user-guide/src/docbkx/images/environments/main-envs.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 37 KiB

0
src/user-guide/src/docbkx/images/Environments/rename-env.png → src/user-guide/src/docbkx/images/environments/rename-env.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 40 KiB

BIN
src/user-guide/src/docbkx/images/environments/show-env.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 45 KiB

BIN
src/user-guide/src/docbkx/images/images/index.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 28 KiB

BIN
src/user-guide/src/docbkx/images/images/mark_image.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.3 KiB

BIN
src/user-guide/src/docbkx/images/manage/index.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 45 KiB

BIN
src/user-guide/src/docbkx/images/manage/modify.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 23 KiB

BIN
src/user-guide/src/docbkx/images/manage/upload.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

6
src/user-guide/src/docbkx/user-guide.xml
View File

@ -35,7 +35,7 @@
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="./content/overview.xml" xlink:title="Overview" /> <xi:include href="./content/overview.xml" xlink:title="Overview" />
<xi:include href="./content/images.xml" xlink:title="Murano Images" /> <xi:include href="./content/app_catalog.xml" xlink:title="Application Catalog" />
<xi:include href="./content/environments.xml" xlink:title="Murano Environments"/> <xi:include href="./content/management.xml" xlink:title="Murano Management" />
<xi:include href="./content/metadata.xml" xlink:title="Murano Metadata"/> <xi:include href="./content/troubleshooting.xml" xlink:title="Troubleshooting" />
</book> </book>