From f1b77a7959cc95e3c149efb307e2e6532e1aa6b3 Mon Sep 17 00:00:00 2001 From: Ekaterina Fedorova Date: Tue, 26 Nov 2013 21:11:34 +0400 Subject: [PATCH] Cherry-pick from release-0.3: *Updated How to Contribute *Renamed guide in pom.xml *Added new Linux services & MS SQL Cluster Service *Updated version to 0.3 *Updated list of known issues *Corrected info about tagging images *Add Linux image build chapter *Added MS SQL Cluster enabling instructions Change-Id: I714d6a45ec81cda5d9ec7822135a6e6c3028f671 --- src/administrators-guide/pom.xml | 2 +- .../src/docbkx/administrators-guide.xml | 18 +- .../src/docbkx/content/image-bulder.xml | 29 +- src/developers-guide/pom.xml | 4 +- .../src/docbkx/content/knownissues.xml | 13 + .../src/docbkx/content/specification.xml | 538 +++++++++++++++++- .../src/docbkx/developers-guide.xml | 24 +- src/getting-started/pom.xml | 2 +- .../docbkx/content/setup_lab_environment.xml | 2 +- .../src/docbkx/getting-started.xml | 20 +- src/user-guide/pom.xml | 2 +- src/user-guide/src/docbkx/user-guide.xml | 24 +- 12 files changed, 538 insertions(+), 140 deletions(-) diff --git a/src/administrators-guide/pom.xml b/src/administrators-guide/pom.xml index fdf1c78..38ed0a9 100644 --- a/src/administrators-guide/pom.xml +++ b/src/administrators-guide/pom.xml @@ -20,7 +20,7 @@ 4.0.0 com.mirantis.murano administrators-guide - 1.0.0-SNAPSHOT + 0.3 jar Murano Administrator's Guide diff --git a/src/administrators-guide/src/docbkx/administrators-guide.xml b/src/administrators-guide/src/docbkx/administrators-guide.xml index 979c6c1..e4c1fb7 100644 --- a/src/administrators-guide/src/docbkx/administrators-guide.xml +++ b/src/administrators-guide/src/docbkx/administrators-guide.xml @@ -23,29 +23,13 @@ http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd" version="5.0"> Murano Administrator's Guide - - - - - v0.2 - Murano - 2013-09-09 + v0.3 Copyright details are filled in by the template. Change the value of the role attribute on the legal notice element to change the license. - - This document is intended for individuals who wish to install and use our product - or intend to contribute. - - - this is a placeholder for the front cover - - - this is a placeholder for the back cover - diff --git a/src/administrators-guide/src/docbkx/content/image-bulder.xml b/src/administrators-guide/src/docbkx/content/image-bulder.xml index 88577d7..c20c46c 100644 --- a/src/administrators-guide/src/docbkx/content/image-bulder.xml +++ b/src/administrators-guide/src/docbkx/content/image-bulder.xml @@ -725,32 +725,14 @@ Replace <IMAGE_METADATA> with the following property string -murano_image_info='{"title": "Windows 2012 Core Edition", "type": "ws-2012-core"}' +murano_image_info='{"title": "Windows 2012 Standart Edition", "type": "windows.2012"}' where - title - user-friendly description of the image - + title - user-friendly description of the image - type - one of possible image types - - ws-2012-std - Windows Server 2012 Standart - Edition - - - ws-2012-core - Windows 2012 Core Edition - - - - ws-2008r2-std - Windows Server 2008R2 - Standart Edition - - - ws-2008r2 - Windows Server 2012R2 - - - + type - is a image type, for example 'windows.2012' @@ -772,7 +754,7 @@ murano_image_info='{"title": "Windows 2012 Core Edition", "type": "ws-2012-core" Replace <IMAGE_METADATA> with murano_image_info property, e.g. -murano_image_info='{"title": "Windows 2012 Core Edition", "type": "ws-2012-core"}' +murano_image_info='{"title": "Windows 2012 Standart Edition", "type": "windows.2012"}' @@ -790,5 +772,4 @@ murano_image_info='{"title": "Windows 2012 Core Edition", "type": "ws-2012-core" After these steps desired image can be chosen in Murano dashboard and used for services platform. - - + diff --git a/src/developers-guide/pom.xml b/src/developers-guide/pom.xml index e068917..ad08628 100644 --- a/src/developers-guide/pom.xml +++ b/src/developers-guide/pom.xml @@ -20,9 +20,9 @@ 4.0.0 com.mirantis.murano developers-guide - 1.0.0-SNAPSHOT + 0.3 jar - Murano Project Documentation + Murano Developers Guide diff --git a/src/developers-guide/src/docbkx/content/knownissues.xml b/src/developers-guide/src/docbkx/content/knownissues.xml index ff05bc6..533c468 100644 --- a/src/developers-guide/src/docbkx/content/knownissues.xml +++ b/src/developers-guide/src/docbkx/content/knownissues.xml @@ -57,5 +57,18 @@ And deploy will hang up. + + + MS SQL Cluster service relies on Quantum for 'virtual-ip' (address-pair) functionality, and to work + on Nova Network or Quantum configured as "Mixed Flat and Private Network", anti-spoofing rules on + compute nodes should be disabled. + + Internet Information Services Web Farm & ASP.NET Application Web Farm services are based on Heat, + particularly on resource called AWS::ElasticLoadBalancing::LoadBalancer, that currently does not support + specification of any network related parameters. Without support for network configuration specification + LoadBalancer does not work in Murano over OpenStack deployments with Quantum configured + as "Per-tenant Routers with Private Networks". + + \ 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 796940d..77e81e4 100644 --- a/src/developers-guide/src/docbkx/content/specification.xml +++ b/src/developers-guide/src/docbkx/content/specification.xml @@ -1647,6 +1647,11 @@ + + id + string + Unique ID + type string @@ -1742,6 +1747,7 @@ Please, refer to Shared Attributes article for shared/common attributes specification. + Type: activeDirectory
Request Object Specs @@ -1758,11 +1764,6 @@ - - id - string - Unique ID - name string @@ -1898,6 +1899,7 @@ This section describes API calls for managing Windows web-server software – IIS. Please, refer to Shared Attributes article for shared/common attributes specification. + Type: webServer
Request Object Specs
@@ -1914,11 +1916,6 @@ - - id - string - Unique ID - name string @@ -2041,6 +2038,7 @@ Please, refer to Shared Attributes article for shared/common attributes specification. + Type: aspNetApp
Request Object Specs
@@ -2057,11 +2055,6 @@ - - id - string - Unique ID - name string @@ -2201,6 +2194,7 @@ Please, refer to Shared Attributes article for shared/common attributes specification. + Type: webServerFarm
Request Object Specs
@@ -2217,11 +2211,6 @@ - - id - string - Unique ID - name string @@ -2357,6 +2346,7 @@ Please, refer to Shared Attributes article for shared/common attributes specification. + Type: aspNetAppFarm
Request Object Specs
@@ -2373,11 +2363,6 @@ - - id - string - Unique ID - name string @@ -2526,6 +2511,7 @@ This section describes API calls for managing MS SQL Server Service. Please, refer to Shared Attributes article for shared/common attributes specification. + Type: msSqlServer
Request Object Specs
@@ -2542,11 +2528,6 @@ - - id - string - Unique ID - name string @@ -2690,5 +2671,502 @@
+
+ MS SQL Server Cluster Specs + This section describes API calls for managing MS SQL Server Cluster Service. + Please, refer to Shared Attributes article for shared/common + attributes specification. + Type: msSqlClusterServer +
+ Request Object Specs + + MS SQL Server Object + + + + + + + Attribute + Type + Description + + + + + name + string + User-friendly name + + + externalAD + boolean + Is Active Directory is configured by the System Administrator + + + domainAdminUserName + string + Username for Active Directory user with admin role, if Active Directory is configured by the System Administrator + + + domain + string + Domain name. + This attribute may be empty/null/omitted + if machine is not a domain member + + + + mixedModeAuth + bool + Use LDAP to access SQL Server + + + clusterIp + string + A valid IPv4 fixed IP + + + clusterName + string + Service name for new SQL Cluster service + + + agGroupName + string + Availability Group Name + + + agListenerName + string + FQDN name of a new DNS entry for AG Listener endpoint + + + agListenerIP + string + Availability Group Listener IP + + + units + object + MS SQL Server Cluster Unit object + + + +
+ + MS SQL Server Cluster Unit object + + + + + + + Attribute + Type + Description + + + + + id + string + Unique ID + + + isMaster + boolean + Is this node master? + + + isSync + boolean + Is this node in sync mode? + + + +
+
+
+ Create Object Specs + + MS SQL Server Cluster Unit object + + + + + + + + Attribute + Type + Required + Description + + + + + name + string + User-friendly name + + + adminPassword + string + Domain password + + + externalAD + boolean + Is Active Directory is configured by the System Administrator + + + domainAdminUserName + string + Username for Active Directory user with admin role, if Active Directory is configured by the System Administrator + + + domainAdminPassword + string + Password for Active Directory user with admin role, if Active Directory is configured by the System Administrator + + + domain + string + Domain name. + This attribute may be empty/null/omitted + if machine is not a domain member + + + + mixedModeAuth + bool + Use LDAP to access SQL Server + + + saPassword + string + SQL Server admin password + + + clusterIp + string + A valid IPv4 fixed IP + + + clusterName + string + Service name for new SQL Cluster service + + + agGroupName + string + Availability Group Name + + + agListenerName + string + FQDN name of a new DNS entry for AG Listener endpoint + + + agListenerIP + string + Availability Group Listener IP + + + sqlServicePassword + string + User password that will be created to manage cluster instances + + + units + object + SQL Server Cluster Unit object + + + +
+ + MS SQL Server Cluster Unit Object + + + + + + + + Attribute + Type + Required + Description + + + + + isMaster + boolean + yes + Is this node master? + + + isSync + boolean + yes + Is this node in sync mode? + + + +
+
+
+
+ Linux Apache Specs + This section describes objects specs for Active Directory service. + + Please, refer to Shared Attributes article for shared/common + attributes specification. + Type: linuxApacheService +
+ Request Object Specs + + Linux Apache Object + + + + + + + Attribute + Type + Description + + + + + name + string + Domain name + + + deployApachePHP + boolean + Enable PHP support on installed service + + + units + object + Linux Apache Unit object + + + +
+ + Linux Apache Unit Object + + + + + + + Attribute + Type + Description + + + + + - + - + - + + + +
+
+
+ Create Object Specs + + Linux Apache Object + + + + + + + + Attribute + Type + Required + Description + + + + + name + string + yes + Domain name + + + deployApachePHP + boolean + no + Enable PHP support on installed service + + + units + object + yes + Linux Apache Unit object + + + +
+ + Linux Apache Unit Object + + + + + + + + Attribute + Type + Required + Description + + + + + - + - + - + - + + + +
+
+
+
+ Linux Telnet Specs + This section describes objects specs for Linux Telnet service. + + Please, refer to Shared Attributes article for shared/common + attributes specification. + Type: linuxTelnetService +
+ Request Object Specs + + Linux Telnet Object + + + + + + + Attribute + Type + Description + + + + + name + string + Domain name + + + units + object + Linux Telnet Unit object + + + +
+ + Linux Telnet Unit Object + + + + + + + Attribute + Type + Description + + + + + - + - + - + + + +
+
+
+ Create Object Specs + + Linux Telnet Object + + + + + + + + Attribute + Type + Required + Description + + + + + name + string + yes + Domain name + + + units + object + yes + Linux Telnet Unit object + + + +
+ + Linux Telnet Unit Object + + + + + + + + Attribute + Type + Required + Description + + + + + - + - + - + - + + + +
+
+
\ No newline at end of file diff --git a/src/developers-guide/src/docbkx/developers-guide.xml b/src/developers-guide/src/docbkx/developers-guide.xml index 8e6a094..27f6913 100644 --- a/src/developers-guide/src/docbkx/developers-guide.xml +++ b/src/developers-guide/src/docbkx/developers-guide.xml @@ -24,14 +24,7 @@ version="5.0"> Murano Developers Guide - - - - - - v0.2 - Murano - 2013-09-09 + v0.3 Copyright details are filled in by the template. Change @@ -40,21 +33,10 @@ - - 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 - - + @@ -67,7 +49,7 @@ openstack-dev@lists.openstack.org - We’re going to hold public weekly meetings on Mondays at 15:00 UTC on #openstack-meeting-alt irc channel. + We’re going to hold public weekly meetings on Tuesdays at 17:00 UTC on #openstack-meeting-alt irc channel. If you want to contribute either to docs or to code, simply send us change request via review.openstack.org diff --git a/src/getting-started/pom.xml b/src/getting-started/pom.xml index b17ab26..6844f13 100644 --- a/src/getting-started/pom.xml +++ b/src/getting-started/pom.xml @@ -20,7 +20,7 @@ 4.0.0 com.mirantis.murano murano-getting-started-guide - 1.0.0-SNAPSHOT + 0.3 jar Murano Getting Started Guide diff --git a/src/getting-started/src/docbkx/content/setup_lab_environment.xml b/src/getting-started/src/docbkx/content/setup_lab_environment.xml index 8790bb2..7c37f19 100644 --- a/src/getting-started/src/docbkx/content/setup_lab_environment.xml +++ b/src/getting-started/src/docbkx/content/setup_lab_environment.xml @@ -442,7 +442,7 @@ >$ cd /opt/image-builder/share/images >$ glance image-create --name ws-2012-std --disk-format qcow2 \ --container-format bare --file ws-2012-std.qcow2 --is-public true \ - --property murano_image_info='{"type":"ws-2012-std", "title":"Windows Server 2012 Standard"}' + --property murano_image_info='{"type":"windows.2012", "title":"Windows Server 2012 Standard"}' diff --git a/src/getting-started/src/docbkx/getting-started.xml b/src/getting-started/src/docbkx/getting-started.xml index 0433b20..1256fe9 100644 --- a/src/getting-started/src/docbkx/getting-started.xml +++ b/src/getting-started/src/docbkx/getting-started.xml @@ -24,14 +24,7 @@ version="5.0"> Murano Getting Started Guide - - - - - - v0.2 - Murano - 2013-09-09 + v0.3 Copyright details are filled in by the template. Change @@ -40,17 +33,6 @@ - - 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 - diff --git a/src/user-guide/pom.xml b/src/user-guide/pom.xml index 0bf9a07..f9a889c 100644 --- a/src/user-guide/pom.xml +++ b/src/user-guide/pom.xml @@ -20,7 +20,7 @@ 4.0.0 com.mirantis.murano user-guide - 1.0.0-SNAPSHOT + 0.3 jar Murano User Guide diff --git a/src/user-guide/src/docbkx/user-guide.xml b/src/user-guide/src/docbkx/user-guide.xml index 6fcd89b..28b8398 100644 --- a/src/user-guide/src/docbkx/user-guide.xml +++ b/src/user-guide/src/docbkx/user-guide.xml @@ -24,18 +24,7 @@ version="5.0"> Murano User Guide - - - - - - - - - - v0.2 - Murano - 2013-09-09 + v0.3 Copyright details are filled in by the template. Change @@ -44,17 +33,6 @@ - - This document is intended for individuals who wish to - use Murano Product. - - - - this is a placeholder for the front cover - - - this is a placeholder for the back cover -