diff --git a/src/developers-guide/src/docbkx/content/knownissues.xml b/src/developers-guide/src/docbkx/content/knownissues.xml index f521cef..ff05bc6 100644 --- a/src/developers-guide/src/docbkx/content/knownissues.xml +++ b/src/developers-guide/src/docbkx/content/knownissues.xml @@ -45,9 +45,6 @@ no "insecure" flag passed etc. - - Murano-Conductor doesn't work with python-heatclient>0.2.1. - Farm services can't be deployed without KeyPair. If KeyPair is not set diff --git a/src/user-guide/src/docbkx/content/murano-dashboard.xml b/src/user-guide/src/docbkx/content/murano-dashboard.xml index 1800cba..680c0ff 100644 --- a/src/user-guide/src/docbkx/content/murano-dashboard.xml +++ b/src/user-guide/src/docbkx/content/murano-dashboard.xml @@ -23,42 +23,44 @@ version="5.0"> Murano dashboard plugin - For a Murano usage you should be familiar with Openstack. Murano Dashboard is just a plugin to Openstack dashboard - Horizon. + To use Murano you should be familiar with Openstack. Murano Dashboard is just a plugin to Openstack dashboard - Horizon. Please visit horizon user guide - first to see how dashboard is organized and how login to it. + first to see how dashboard is organized and how to login to it.
Creating environment Once you installed all Murano components and login to horizon dashboard successfully you will see Environments panel: - + - First you need to do is to create an environment - virtual Windows Data Center which will contain different Windows services. - Navigate to "Environments" page and click "Create Environment". After setting name to your virtual environment it will be created. + First thing you need to do is to create an environment - virtual Windows Data Center which will contain different Windows services. + Navigate to the "Environments" page and click the "Create Environment". After setting name to your virtual environment it will be created. Just created environment has status Ready to configure. - +
Creating service prototype - All services should be created within the framework of Environment - - virtual Windows Data Center. First you need to create one or more service's prototypes - and then send Environment to deploy process. After that one or more instances with your service be spawned on Openstack. + All services should be created in the context of Environment + - virtual Windows Data Center. After Environment is created services prototypes + and then deploy the Environment. When deploy process is done instances + with your service will be spawned in Openstack. To create service prototype navigate to environment services by - clicking on environment name (or on "Services" button) and press on "Create Service" button. + clicking on the environment name (or on the "Services" button) and click + the "Create Service" button. - + @@ -66,7 +68,7 @@ - + @@ -147,14 +149,14 @@ - +
Active Directory - +
@@ -162,7 +164,7 @@ Internet Information Service - +
@@ -170,7 +172,7 @@ Internet Information Web Farm Service - + @@ -178,7 +180,7 @@ ASP.NET Service - + @@ -186,7 +188,7 @@ ASP.NET Farm Service - + @@ -194,7 +196,7 @@ MS SQL Service - + @@ -202,17 +204,17 @@ SQL Server Failover Cluster - + - + - + @@ -220,22 +222,31 @@
Deploying environment - Once all services are prepared you can send environment to deploy - and wait while Murano installing and configuring your services. + Once all services are prepared you can send environment to deploy. Just press the "Deploy Environment" button. - + + + 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. + + + + + + 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. - + @@ -243,20 +254,280 @@ - + - - Until installation finished environment are in deployng state. + As long as installation and configuration are in progress environment + is in Deploying state. Depending on how many + services 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. -
-
- Detailed information - + -
+ + If installation process finished without any errors environment changes its status to + Ready: + + + + + + + +
+ Working with deployed environment + + Congratulations! After some time waiting you are able to operate with the services. + To get information about installed services 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. + + + + + + + + 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. + + + + + + + + You can login to the virtual machine directly from the horizon (if you Openstack installation allows you) or by RDP protocol. + + + + + + + There are more things you can do with Murano Environment: + + + Add new services and deploy it again; + + + Delete outdated and unnecessary environments or services; + + + Browse deployment history and service installation logs; + + + Rename your environment. + + +
+ Redeploying Murano Environment + + Murano gives opportunity to supplement already deployed environment. + If you deployed the Active Directory service and want to create + any other service just create desired service prototype and click on the "Deploy Environment" button. + During service prototype creation you can join this service to the existent Active Directory domain. + +
+
+ Deleting + Services as well as environments can be easily deleted. + + + To delete an environment go to the environment index page and click "More" -> "Delete Environment" in Actions column of ready to delete environment. + + + + + + + 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. + + + + + To delete a service go service list page and click the "Delete Service" button in Actions column. Note: + If you are deleting service that was already deployed you'll need to Deploy the environment again by pressing corresponding button. + In case you want to delete service prototype - it has "Service draft created" in the + Last operation column (see the screenshot below) - changes applies right away. + + + + + + + + +
+
+ Browsing Murano Deployment + + 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: + + + + + + + + From this page it's easy to see how many times and when Murano Environment was deployed: + + + + + + + + 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: + + + + + + + Also deployment logs are available at the "Logs" tab: + + + + + +
+
+ Renaming Murano Environment + + It's possible to change name of your environment: just click the "More-> Edit Environment" button on environment index page: + + + + + + + + Environment name is not involved in service creation process so you can use spaces and any other + characters you want. + + + + + + +
+
+
+ Troubleshooting + How to debug OpenStack Heat? + + + If you can execute Heat command via console interface - all good. It is + the most simple way to check Heat state on the node - jest execute CLI + command 'heat list'. + + See more information about Heat in openstack wiki + page + + If 'heat list' returns 503 error + + It is means that OpenStack Heat configuration files contains incorrect + credentials. Need to set 'user' = 'heat' and change passwords + 'verybadpass' in all configuration files from directory /etc/heat/ + + If 'heat list' hangs up + + Sometimes ypu can see that 'heat list' hangs up. The root of this + problem - connection to the rabbitMQ. + + How I can connect to LoadBalancer instance in Server Farms? + + First of all you should have KeyPair file 'murano-lb-key', you can + create this file using commands + + murano-lb-key.priv +chmod 600 murano-lb-key.priv + ]]> + + And after that you should create server farms with this KeyPair. + The second step is to 'how to connect to VM with LoadBalancer': + + + + + Murano dashboard can not connect to Murano API. How I can fix it? + + This is problem has two ways to fix: + Add string + + + + + to file /etc/openstack-dashboard/local_settings (or + /etc/openstack-dashboard/local_settings.py - it is depends on OpenStack + configuration) + and after that need to restart web server. + Add keystone endpoints for Murano API + + + + + + Murano API Service does not work on CentOS 6.x. WebUI can not connect + to this service. How to fix this? + + + The problem in pip lib routes. Need to upgrade this lib and restart + Murano API: + + + + + + Error 'Unexpected state' during the deployment of Web Farms. What the + problem? + + + Sometimes we can see in logs of the deployments: + + + + The root of this problem in incorrect configuration - Heat can not + create Load Balancer instance. Please, remember that you should have + admin access for project in OpenStack to deploy LoadBalancer and also, + you should have KeyPair with default name 'murano-lb-key'. + + Error in Murano API logs 'No module named helpers.token_sanitizer' + + This is problem with pip version. Need to install pip 1.4 and after that reinstall murano-client, murano-common and murano-api. + +
\ No newline at end of file diff --git a/src/user-guide/src/docbkx/content/overview.xml b/src/user-guide/src/docbkx/content/overview.xml index 0e9f89c..781eccf 100644 --- a/src/user-guide/src/docbkx/content/overview.xml +++ b/src/user-guide/src/docbkx/content/overview.xml @@ -24,9 +24,8 @@ How can I use Murano Service? Murano is intended to get opportunity for non-experienced - users to deploy reliable Windows-based environments with 1-Click. - This document describes steps for creation Windows Environment with different services. - You'll see how it's easy with Murano. + users to deploy reliable Windows-based environments extremely simple. + This document describes process of creation virtual Windows Environment with different services.
Document change history diff --git a/src/user-guide/src/docbkx/images/deploy_btn.png b/src/user-guide/src/docbkx/images/deploy_btn.png index 6bd128c..96ee3e3 100644 Binary files a/src/user-guide/src/docbkx/images/deploy_btn.png and b/src/user-guide/src/docbkx/images/deploy_btn.png differ diff --git a/src/user-guide/src/docbkx/images/deploy_started.png b/src/user-guide/src/docbkx/images/deploy_started.png index 4f1dd12..41a9109 100644 Binary files a/src/user-guide/src/docbkx/images/deploy_started.png and b/src/user-guide/src/docbkx/images/deploy_started.png differ diff --git a/src/user-guide/src/docbkx/images/done.png b/src/user-guide/src/docbkx/images/done.png index aac110a..bfba3cc 100644 Binary files a/src/user-guide/src/docbkx/images/done.png and b/src/user-guide/src/docbkx/images/done.png differ diff --git a/src/user-guide/src/docbkx/images/env_btn.png b/src/user-guide/src/docbkx/images/env_btn.png index 45b1664..ce9e1e3 100644 Binary files a/src/user-guide/src/docbkx/images/env_btn.png and b/src/user-guide/src/docbkx/images/env_btn.png differ diff --git a/src/user-guide/src/docbkx/images/env_created.png b/src/user-guide/src/docbkx/images/env_created.png index 3f1d1e2..0e94480 100644 Binary files a/src/user-guide/src/docbkx/images/env_created.png and b/src/user-guide/src/docbkx/images/env_created.png differ diff --git a/src/user-guide/src/docbkx/images/env_deploy.png b/src/user-guide/src/docbkx/images/env_deploy.png index 68dbf02..cdba929 100644 Binary files a/src/user-guide/src/docbkx/images/env_deploy.png and b/src/user-guide/src/docbkx/images/env_deploy.png differ diff --git a/src/user-guide/src/docbkx/images/env_panel.png b/src/user-guide/src/docbkx/images/env_panel.png index 8aeefc8..27af7a0 100644 Binary files a/src/user-guide/src/docbkx/images/env_panel.png and b/src/user-guide/src/docbkx/images/env_panel.png differ diff --git a/src/user-guide/src/docbkx/images/logs.png b/src/user-guide/src/docbkx/images/logs.png index 594da67..6780bff 100644 Binary files a/src/user-guide/src/docbkx/images/logs.png and b/src/user-guide/src/docbkx/images/logs.png differ diff --git a/src/user-guide/src/docbkx/images/service_btn.png b/src/user-guide/src/docbkx/images/service_btn.png index 3f00f26..a74b5ad 100644 Binary files a/src/user-guide/src/docbkx/images/service_btn.png and b/src/user-guide/src/docbkx/images/service_btn.png differ diff --git a/src/user-guide/src/docbkx/images/service_list.png b/src/user-guide/src/docbkx/images/service_list.png index 6f5fd16..6f17910 100644 Binary files a/src/user-guide/src/docbkx/images/service_list.png and b/src/user-guide/src/docbkx/images/service_list.png differ diff --git a/src/user-guide/src/docbkx/images/service_name.png b/src/user-guide/src/docbkx/images/service_name.png index 11d8040..fc8bdd1 100644 Binary files a/src/user-guide/src/docbkx/images/service_name.png and b/src/user-guide/src/docbkx/images/service_name.png differ diff --git a/src/user-guide/src/docbkx/images/services.png b/src/user-guide/src/docbkx/images/services.png index d38e141..5665e94 100644 Binary files a/src/user-guide/src/docbkx/images/services.png and b/src/user-guide/src/docbkx/images/services.png differ diff --git a/src/user-guide/src/docbkx/user-guide.xml b/src/user-guide/src/docbkx/user-guide.xml index a8da49e..68af2a7 100644 --- a/src/user-guide/src/docbkx/user-guide.xml +++ b/src/user-guide/src/docbkx/user-guide.xml @@ -22,7 +22,7 @@ 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"> - Murano Developers Guide + Murano User Guide