diff --git a/src/user-guide/src/docbkx/content/murano-dashboard.xml b/src/user-guide/src/docbkx/content/environments.xml similarity index 83% rename from src/user-guide/src/docbkx/content/murano-dashboard.xml rename to src/user-guide/src/docbkx/content/environments.xml index bbccf4b..a67d494 100644 --- a/src/user-guide/src/docbkx/content/murano-dashboard.xml +++ b/src/user-guide/src/docbkx/content/environments.xml @@ -21,23 +21,33 @@ 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 dashboard plugin + Environments - 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 to login to it. + Murano Environment - 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: + + + Create; + + + Delete; + + + Deploy. + + + More information about actions with environment are described in this chapter.
Creating environment - Once you installed all Murano components and login to horizon dashboard successfully you will see Environments panel: + Once you installed all Murano components and logged-in to horizon dashboard successfully you will see Murano tab: - First thing you need to do is to create an environment - virtual Windows Data Center which will contain different Windows services. + First thing you need to do is to create an environment. To do this, navigate to the "Environments" page and click the "Create Environment". After setting name to your virtual environment it will be created. @@ -59,8 +69,7 @@
Creating service prototype - All services should be created in the context of Environment - - virtual Windows Data Center. After Environment is created, you need to create services prototypes + All services should be created in the context of Environment. After Environment is created, you need to create service prototypes and then deploy the Environment. When deploy process is done instances with your services will be spawned in Openstack. To create a service prototype navigate to page with the list of environment services by @@ -86,6 +95,26 @@ To see more information about filling the form for a specific service follow one of the link below: + + + + ASP.NET Service: + + 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. + + + + + + ASP.NET Farm Service: + + ASP.NET Farm Service installs a custom application on a + load-balanced array of IIS servers. + + Active Directory: @@ -95,6 +124,22 @@ Any other services you are intending to create can be joined to that domain. + + + + + Apache Service: + 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. + + + + + + Demo Service: + Installs test service that demonstrates how to Murano interconnects with Murano Demo Agent. + For this service light-weight Linux Cirros image can be used. + @@ -115,22 +160,9 @@ - - ASP.NET Service: - - 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. - - - - - - ASP.NET Farm Service: - - ASP.NET Farm Service installs a custom application on a - load-balanced array of IIS servers + Linux Telnet: + Telnet - is a network protocol used to provide a bidirectional interactive + text-oriented communication facility using a virtual terminal connection. @@ -142,7 +174,7 @@ - SQL Server Failover Cluster: + MS SQL Server Failover Cluster: Murano installs all needed components and configures your SQL Server Cluster the way you want. @@ -304,7 +336,7 @@
- SQL Server Failover Cluster + MS SQL Server Failover Cluster @@ -442,6 +474,114 @@
+
+ Linux Apache Service + + + + + + + + + + + + Service Name + + + + Enter a desired name for a service. Just A-Z, + a-z, 0-9, dash and underline are allowed. + + + + + + PHP module + + + + PHP module can be installed with Apache. + Enable or disable this options via checkbox. + + + + + + Key Pair + + + + Select SSH Key Pair from the existing to + control access to your instance. + + + + + + Hostname + + + + Machine hostname. + If blank - random name will be used. + + + + + +
+
+ Linux Telnet Service + + + + + + + + + + + + Service Name + + + + Enter a desired name for a service. Just A-Z, + a-z, 0-9, dash and underline are allowed. + + + + + + Key Pair + + + + Select SSH Key Pair from the existing. + + + + + + Hostname + + + + Machine hostname. + If blank - random name will be used. + + + + + +
Deploying environment @@ -752,4 +892,4 @@ initctl start murano-api This pip version problem. 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/images.xml b/src/user-guide/src/docbkx/content/images.xml new file mode 100644 index 0000000..ded9493 --- /dev/null +++ b/src/user-guide/src/docbkx/content/images.xml @@ -0,0 +1,105 @@ + + + + Images + + Murano uses preconfigured images for spawning instances. Image + suitable for Murano should have Murano Agent installed at least. See + + here how to build Murano images and upload it to Glance. Since Murano + supports different operating systems it'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 + Images + panel. + + To operate with Glance Images you need to have admin + rights! + + + + + You are browsing Glance images with correctly set + "murano_image_info" property - image metadata. From this + view you are able to: + + + Delete an existing image metadata with "Delete + Metadata" button (only image's property get deleted, + the image itself stays in Glance) + + + Add new murano metadata to an image that is already registered + in Glance by clicking on "Mark + Image" button + + + Take a look at the "Mark Image" form: + + + + + + + + + + + + Image + + + From all images registered in Glance pick one that was created with + Murano Image Builder. + + + + + Title + + + Set name for a selected image to recognize it easier during + service creation. + + + + + Type + + + + For now there are three supported types: + + + Windows Server 2012 - used to build Windows-based + applications + + + Murano Demo - light-weight Linux Cirros image with + Murano Demo Agent + + + Generic Linux - used to build Linux-based + applications + + + + + + + + + diff --git a/src/user-guide/src/docbkx/content/metadata.xml b/src/user-guide/src/docbkx/content/metadata.xml new file mode 100644 index 0000000..3748b6b --- /dev/null +++ b/src/user-guide/src/docbkx/content/metadata.xml @@ -0,0 +1,208 @@ + + + + Metadata Repository + This chapter describes how to operate with Murano Metadata + Repository via UI. + + Metadata Repository is a REST API server stores all data + necessary for a service deployment. Information about service and + it's dependencies is called service definition + or manifest. 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: + + + ui - UI definitions for Murano + dashboard + + + workflows - set of rules for Murano + Conductor + + + heat - templates for spawning instance + with Heat + + + agent - Murano Agent templates + + + scripts - Murano Execution Plans + + + In "Murano" tab go to the "Service Definitions" panel: + + + + + + From this view you are able to perform the following actions: + + + Compose Service 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. + + + Upload Service provides a form for + uploading tar.gz archive with already composed service manifest and + other dependency files. + + + Manage Files button will redirect you to + a view where you can manipulate with all files stored in Metadata + Repository: download, delete or upload new ones. + + + Toggle Active button will make service + active or inactive depending on the current state. + + + Modify Service gives you opportunity to + modify attributes of service definition. + + + Manage Service 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. + + + Download Service saves archive with all + files used by specified service. + + + Delete Service removes service manifest + and all dependencies that are not used by other services from + Murano Repository server. + + + + +
+ + Compose Service + + + Let's review service creation in details. + After clicking on "Compose Service" button from "Service Definitions" view you'll see the following form: + + + + 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 Manage Files view. + + + + 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 + "Create Service" form. All other tabs refer to a files required for a service's deployment phase. + + + + +
+
+ Manage Files + + 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. + + + + The following actions are available: + + + Download file, + + + Delete file, + + + Upload file. + + + To upload file to repository you need to fill up this form: + + + + + + + + + + Murano Repository File + + + Select file for uploading. It should be not bigger than 5Mb. + + + + + File Type + + + + Select one of supported type. It will be loaded directly to a directory that stores corresponding file types. + + + + + + +
+
+ + Manage Service + + + Manage Service view displays general information about service and list of file dependency grouped by a separate tables. + + + + In the following view these actions are available: + + + + View service detail information. + + + + + Download File. + + + + Delete file. + + + + Upload file of the exact type by pressing the <File type>" button in the appropriate table. + + + + +
+ diff --git a/src/user-guide/src/docbkx/content/overview.xml b/src/user-guide/src/docbkx/content/overview.xml index 781eccf..16f7aad 100644 --- a/src/user-guide/src/docbkx/content/overview.xml +++ b/src/user-guide/src/docbkx/content/overview.xml @@ -24,32 +24,52 @@ How can I use Murano Service? Murano is intended to get opportunity for non-experienced - users to deploy reliable Windows-based environments extremely simple. - This document describes process of creation virtual Windows Environment with different services. + users to deploy different kinds of applications extremely simple. + 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 to login into it. + This document describes Murano Dashboard usage in detail.
Document change history The following table describes the most recent changes: - - - Revision Date - Summary of Changes - - - - - September. 4, 2013 - - - - Initial document creation. - - - - - - + + + + + + Revision Date + Summary of Changes + + + + + + September. 4, 2013 + + + + + Update for Release-0.2 + + + + + + + December. 9, 2013 + + + + + Update for Release-0.4 + + + + + + +
- - \ No newline at end of file + diff --git a/src/user-guide/src/docbkx/images/Images/Image 13.png b/src/user-guide/src/docbkx/images/Images/Image 13.png new file mode 100644 index 0000000..611fa33 Binary files /dev/null and b/src/user-guide/src/docbkx/images/Images/Image 13.png differ diff --git a/src/user-guide/src/docbkx/images/Images/index.png b/src/user-guide/src/docbkx/images/Images/index.png new file mode 100644 index 0000000..5cf57e4 Binary files /dev/null and b/src/user-guide/src/docbkx/images/Images/index.png differ diff --git a/src/user-guide/src/docbkx/images/Images/mark_image.png b/src/user-guide/src/docbkx/images/Images/mark_image.png new file mode 100644 index 0000000..63445c7 Binary files /dev/null and b/src/user-guide/src/docbkx/images/Images/mark_image.png differ diff --git a/src/user-guide/src/docbkx/images/Metadata/compose_service1.png b/src/user-guide/src/docbkx/images/Metadata/compose_service1.png new file mode 100644 index 0000000..7240c7f Binary files /dev/null and b/src/user-guide/src/docbkx/images/Metadata/compose_service1.png differ diff --git a/src/user-guide/src/docbkx/images/Metadata/compose_service2.png b/src/user-guide/src/docbkx/images/Metadata/compose_service2.png new file mode 100644 index 0000000..3e03da8 Binary files /dev/null and b/src/user-guide/src/docbkx/images/Metadata/compose_service2.png differ diff --git a/src/user-guide/src/docbkx/images/Metadata/compose_service3.png b/src/user-guide/src/docbkx/images/Metadata/compose_service3.png new file mode 100644 index 0000000..1a945f7 Binary files /dev/null and b/src/user-guide/src/docbkx/images/Metadata/compose_service3.png differ diff --git a/src/user-guide/src/docbkx/images/Metadata/index.png b/src/user-guide/src/docbkx/images/Metadata/index.png new file mode 100644 index 0000000..75b9836 Binary files /dev/null and b/src/user-guide/src/docbkx/images/Metadata/index.png differ diff --git a/src/user-guide/src/docbkx/images/Metadata/manage_files.png b/src/user-guide/src/docbkx/images/Metadata/manage_files.png new file mode 100644 index 0000000..a24d32e Binary files /dev/null and b/src/user-guide/src/docbkx/images/Metadata/manage_files.png differ diff --git a/src/user-guide/src/docbkx/images/Metadata/manage_files_upload.png b/src/user-guide/src/docbkx/images/Metadata/manage_files_upload.png new file mode 100644 index 0000000..0e4ee57 Binary files /dev/null and b/src/user-guide/src/docbkx/images/Metadata/manage_files_upload.png differ diff --git a/src/user-guide/src/docbkx/images/Metadata/manage_service.png b/src/user-guide/src/docbkx/images/Metadata/manage_service.png new file mode 100644 index 0000000..93281c2 Binary files /dev/null and b/src/user-guide/src/docbkx/images/Metadata/manage_service.png differ diff --git a/src/user-guide/src/docbkx/images/Metadata/upload_tofile.png b/src/user-guide/src/docbkx/images/Metadata/upload_tofile.png new file mode 100644 index 0000000..2cd394c Binary files /dev/null and b/src/user-guide/src/docbkx/images/Metadata/upload_tofile.png differ diff --git a/src/user-guide/src/docbkx/images/apache.png b/src/user-guide/src/docbkx/images/apache.png new file mode 100644 index 0000000..a2c4e99 Binary files /dev/null and b/src/user-guide/src/docbkx/images/apache.png differ diff --git a/src/user-guide/src/docbkx/images/cluster2.png b/src/user-guide/src/docbkx/images/cluster2.png index 44dcf54..f27e0e7 100644 Binary files a/src/user-guide/src/docbkx/images/cluster2.png and b/src/user-guide/src/docbkx/images/cluster2.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 ce9e1e3..032969b 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 0e94480..9413dc3 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_panel.png b/src/user-guide/src/docbkx/images/env_panel.png index 27af7a0..829a6eb 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/service_list.png b/src/user-guide/src/docbkx/images/service_list.png index 6f17910..d7e1c6d 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/telnet.png b/src/user-guide/src/docbkx/images/telnet.png new file mode 100644 index 0000000..beeafc6 Binary files /dev/null and b/src/user-guide/src/docbkx/images/telnet.png differ diff --git a/src/user-guide/src/docbkx/user-guide.xml b/src/user-guide/src/docbkx/user-guide.xml index 28b8398..b5d7919 100644 --- a/src/user-guide/src/docbkx/user-guide.xml +++ b/src/user-guide/src/docbkx/user-guide.xml @@ -24,7 +24,7 @@ version="5.0"> Murano User Guide - v0.3 + v0.4 Copyright details are filled in by the template. Change @@ -35,5 +35,7 @@ - + + +