diff --git a/src/developers-guide/src/docbkx/content/blueprint.xml b/src/developers-guide/src/docbkx/content/architecture.xml similarity index 50% rename from src/developers-guide/src/docbkx/content/blueprint.xml rename to src/developers-guide/src/docbkx/content/architecture.xml index 76f6270..6f857bf 100644 --- a/src/developers-guide/src/docbkx/content/blueprint.xml +++ b/src/developers-guide/src/docbkx/content/architecture.xml @@ -22,100 +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"> - Blueprint -
- - Project Background - Enterprise customers frequently use Windows-based environments for their internal and external - products. Configuration of the Windows environment is a complex task which usually requires a lot of - effort from administrators. Windows setup consists of numerous services which might be tightly coupled - to each other. While the automated installation of Windows services can be fairly straightforward, - service configuration can be hard to automate because it requires a well-designed Windows architecture - and deep knowledge of Windows services configuration. - - Currently several open source solutions exists that can help to partially solve automation of Windows - environment provisioning. In the world of OpenStack there is the Heat project, which is similar to - Amazon Cloud Formation. Heat is an excellent tool for managing OpenStack cloud resources such as VM - instances, security groups, and so on. It allows you to define all cloud resources in a single JSON - template, then later maintain all of those resources by editing that template. Although the declarative - template approach is well suited to OpenStack resources, it quickly becomes complex when it comes to - application management. - - Another option is a tool such as Chef or Puppet. These tools are flexible, but require you to have a - deep knowledge of scripting and require a significant amount of effort to manually script or modify - cookbooks for your specific environment configuration. This is manageable in a stable environment, but - it becomes time-consuming and involves manual script coding when one needs to deploy various - environments with rapidly changing configurations. Also Chef and Puppet require additional - infrastructure to support them. - - The biggest problem for both approaches above is in supporting multi-step configuration of services - with circular dependencies required for correct configuration of Windows services. This can be solved by - using external orchestration. - - Another potential problem is the lack of UI functionality enabling creation and configuration of an - environment without writing a script. - -
- Proposal - Mirantis proposes to introduce a new service which will allow a non-experienced user to deploy - reliable Windows based environments in a “push-the-button” manner. 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 should be able to orchestrate complex circular dependent cases in - order to set up a complex Windows Environment with multiple dependant services. - - The service will address following use cases: - - - Self-provisioning of predefined Windows services with their dependencies - - - Automation of administrative tasks during data center roll-out - - - Custom windows application as a windows service - - - - - The solution will provide higher level of abstraction for manipulation Windows Environments. Key - concepts are: - - - Windows Service - a service such as Active Directory, MSSQL, or IIS, which usually - consists of multiple virtual machines and has multiple dependencies. - - - - Windows Environment - a logical unit for all Services and represents a classical - Windows Datacenter - - - - Windows VM instance - a VM which hosts a Windows Service. A Windows Service might be - deployed - - - - - - The Key Features of the Service are the following: - - - Native to OpenStack - - - Introduces abstraction level for Windows Environments - - - Supports Availability Zones and Disaster Recovery scenarios - - - Uses native Windows features for HA solutions - - - -
-
+ Architecture
Architecture @@ -152,11 +59,11 @@ Architecture - - + @@ -179,9 +86,7 @@ Orchestration Engine This is the core component which evaluates Object Model changes and creates a plan for implementing these changes on the instances or in the cloud. This component will support extensions - via plug-ins. Plugins can add new services and extend existing services for integration. Currently - there are two services which are already implemented as plugins. They are Active Directory and IIS - Service. + via plug-ins. Plugins can add new services and extend existing services for integration.
@@ -190,18 +95,16 @@ Release-0.1 - has 0.1 tag in all Murano repositories. Released 2013-06-19. + has 0.1 tag in all Murano repositories. Released 2013-05-30. Release-0.2 - has 0.2 tag in all Murano repositories. Released - 2013-05-30. + has 0.2 tag in all Murano repositories. Released 2013-09-05. -
Integration with Heat diff --git a/src/developers-guide/src/docbkx/content/installation-guide.xml b/src/developers-guide/src/docbkx/content/installation-guide.xml index e855721..5dbfd14 100644 --- a/src/developers-guide/src/docbkx/content/installation-guide.xml +++ b/src/developers-guide/src/docbkx/content/installation-guide.xml @@ -39,7 +39,8 @@ RHEL/CentOS 6.4 - These system packages are requred for Murano: + These system packages are required for Murano: + Ubuntu python-dev @@ -54,6 +55,23 @@ libffi-dev + + CentOS + + + + python-devel + + + libxml2-devel + + + libxslt-devel + + + libffi-devel + +
@@ -62,7 +80,7 @@ This chapter describes the procedure of installation and condiguration of Murano API.
Install - + Superuser privileges is required to install and configure system packages. Let's switch to root account: @@ -123,7 +141,7 @@ LOG:> Please, make proper configuration,located at "/etc/murano-api", before sta
Configure - + First configure rabbitMQ by adding vhost and user with administrator rights: @@ -214,7 +232,6 @@ source $(YOUR_OPENSTACK_DIR)/openrc $(LOGIN) $(PASSWORD) ]]> - This chapter describes Conductor for contributors of the project.
Install - + Murano Condutor uses OpenStack Heat for new virtual machines creation, therefore Heat should been installed and configured. Some services require the Internet access for virtual machines to @@ -333,11 +350,11 @@ sh setup-centos.sh install ]]> - +
Configure - + Edit configuration file and take a look at inline comments: @@ -354,7 +371,7 @@ cp conductor.conf.sample conductor.conf vi conductor.conf ]]> - + [DEFAULT]section is responsible for logging. diff --git a/src/developers-guide/src/docbkx/content/knownissues.xml b/src/developers-guide/src/docbkx/content/knownissues.xml index 241b4f0..8eb6c28 100644 --- a/src/developers-guide/src/docbkx/content/knownissues.xml +++ b/src/developers-guide/src/docbkx/content/knownissues.xml @@ -46,10 +46,16 @@ - Active Directory service can not be created on Win2008 image. + Murano-Conductor doesn't work with python-heatclient>0.2.1. - Murano-Conductor doesn't work with python-heatclient>0.2.1. + + Farm services can't be deployed without KeyPair. If KeyPair is not set + load balancer won't be created and these messages will show up in logs: +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 + And deploy will hang up. + diff --git a/src/developers-guide/src/docbkx/content/overview.xml b/src/developers-guide/src/docbkx/content/overview.xml index f208b0c..fe8230c 100644 --- a/src/developers-guide/src/docbkx/content/overview.xml +++ b/src/developers-guide/src/docbkx/content/overview.xml @@ -62,6 +62,16 @@ + + September. 4, 2013 + + + + update for Release-0.2 + + + +
diff --git a/src/developers-guide/src/docbkx/content/screenshots.xml b/src/developers-guide/src/docbkx/content/screenshots.xml deleted file mode 100644 index 747311b..0000000 --- a/src/developers-guide/src/docbkx/content/screenshots.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - Screenshots - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/src/developers-guide/src/docbkx/content/specification.xml b/src/developers-guide/src/docbkx/content/specification.xml index c22e078..7726871 100644 --- a/src/developers-guide/src/docbkx/content/specification.xml +++ b/src/developers-guide/src/docbkx/content/specification.xml @@ -36,7 +36,7 @@ - Initial document creation + Initial @@ -2584,7 +2584,7 @@ - ASP.NET Application Farm Unit Object + SQL Server Unit object @@ -2609,7 +2609,7 @@
Create Object Specs
- ASP.NET Application Farm Object + SQL Server Unit object diff --git a/src/developers-guide/src/docbkx/developers-guide.xml b/src/developers-guide/src/docbkx/developers-guide.xml index 550543b..75efcae 100644 --- a/src/developers-guide/src/docbkx/developers-guide.xml +++ b/src/developers-guide/src/docbkx/developers-guide.xml @@ -62,10 +62,9 @@ - + - How To Participate diff --git a/src/developers-guide/src/docbkx/figures/screens/1.png b/src/developers-guide/src/docbkx/figures/screens/1.png deleted file mode 100644 index acc8ade..0000000 Binary files a/src/developers-guide/src/docbkx/figures/screens/1.png and /dev/null differ diff --git a/src/developers-guide/src/docbkx/figures/screens/2.png b/src/developers-guide/src/docbkx/figures/screens/2.png deleted file mode 100644 index a6a2f04..0000000 Binary files a/src/developers-guide/src/docbkx/figures/screens/2.png and /dev/null differ diff --git a/src/developers-guide/src/docbkx/figures/screens/3.png b/src/developers-guide/src/docbkx/figures/screens/3.png deleted file mode 100644 index b345e35..0000000 Binary files a/src/developers-guide/src/docbkx/figures/screens/3.png and /dev/null differ diff --git a/src/developers-guide/src/docbkx/figures/screens/4.png b/src/developers-guide/src/docbkx/figures/screens/4.png deleted file mode 100644 index b07dd32..0000000 Binary files a/src/developers-guide/src/docbkx/figures/screens/4.png and /dev/null differ diff --git a/src/developers-guide/src/docbkx/figures/screens/5.png b/src/developers-guide/src/docbkx/figures/screens/5.png deleted file mode 100644 index 022252c..0000000 Binary files a/src/developers-guide/src/docbkx/figures/screens/5.png and /dev/null differ diff --git a/src/developers-guide/src/docbkx/figures/screens/6.png b/src/developers-guide/src/docbkx/figures/screens/6.png deleted file mode 100644 index 4087b94..0000000 Binary files a/src/developers-guide/src/docbkx/figures/screens/6.png and /dev/null differ diff --git a/src/developers-guide/src/docbkx/figures/screens/7.png b/src/developers-guide/src/docbkx/figures/screens/7.png deleted file mode 100644 index 89d283e..0000000 Binary files a/src/developers-guide/src/docbkx/figures/screens/7.png and /dev/null differ diff --git a/src/user-guide/pom.xml b/src/user-guide/pom.xml new file mode 100644 index 0000000..5166987 --- /dev/null +++ b/src/user-guide/pom.xml @@ -0,0 +1,54 @@ + + + 4.0.0 + com.mirantis.murano + user-guide + 1.0.0-SNAPSHOT + jar + Murano User Guide + + + + com.agilejava.docbkx + docbkx-maven-plugin + + + + generate-pdf + generate-webhelp + + generate-sources + + + + true + 100 + + + + + + + + + + + + diff --git a/src/user-guide/src/docbkx/images/1.png b/src/user-guide/src/docbkx/images/1.png new file mode 100644 index 0000000..8aeefc8 Binary files /dev/null and b/src/user-guide/src/docbkx/images/1.png differ diff --git a/src/user-guide/src/docbkx/images/2.png b/src/user-guide/src/docbkx/images/2.png new file mode 100644 index 0000000..45b1664 Binary files /dev/null and b/src/user-guide/src/docbkx/images/2.png differ diff --git a/src/user-guide/src/docbkx/user-guide.xml b/src/user-guide/src/docbkx/user-guide.xml new file mode 100644 index 0000000..a8da49e --- /dev/null +++ b/src/user-guide/src/docbkx/user-guide.xml @@ -0,0 +1,65 @@ + + + + Murano Developers Guide + + + + + + + + Mirantis, Inc. + + + + 2013 + Mirantis, Inc. + + v0.1 + Murano™ + 2013-09-04 + + + Copyright details are filled in by the template. Change + the value of the role + attribute on the legalnotice element to change the license. + + + + + This document is intended for individuals who wish to + use our product or intend to contribute. + + + + this is a placeholder for the front cover + + + this is a placeholder for the back cover + + + + +