diff --git a/src/murano-manual/src/docbkx/murano-manual.xml b/src/murano-manual/src/docbkx/murano-manual.xml index fda80d2..c8664e3 100644 --- a/src/murano-manual/src/docbkx/murano-manual.xml +++ b/src/murano-manual/src/docbkx/murano-manual.xml @@ -466,6 +466,20 @@ http://docbook.org/ns/docbook " + + Jun 06, 2013 + + + + ASP.NET Application, Web Server Farm and + ASP.NET Application Farm Services Added, + uri/address/endpoint corrections, hostname + assignment section added + + + + +
@@ -619,6 +633,27 @@ http://docbook.org/ns/docbook "
+
+ Hostname assignment + Each Service Object definition may have an attribute + "unitNamingPattern" that is used to control hostnames + that will be assigned to spawned VM instances of the + service. + + + Hostname pattern has the form of "name#" where "#" + character is replaced with sequential number of unit + within the service (starting with 1) and all other + characters remain intact. For example Service with + unitNamingPatter equal to "ad#-loc" will have units + with hostnames "ad1-loc", "ad2-loc" etc. + + + "unitNamingPattern" attribute is optional. + If it is omitted then a unique random hostname + would be assigned. + +
API
@@ -644,7 +679,7 @@ http://docbook.org/ns/docbook " id - guid + string Unique ID @@ -667,8 +702,8 @@ http://docbook.org/ns/docbook " tenant_id - guid - Open Stack tenant id + string + Open Stack tenant ID version @@ -1123,12 +1158,12 @@ http://docbook.org/ns/docbook " id - guid + string Session unique ID environment_id - guid + string Environment that going to be modified during this session @@ -1148,8 +1183,8 @@ http://docbook.org/ns/docbook " user_id - guid - Session owner guid + string + Session owner ID version @@ -1485,7 +1520,7 @@ http://docbook.org/ns/docbook " id - guid + string Unique ID @@ -1510,7 +1545,12 @@ http://docbook.org/ns/docbook " domain string - Domain name (same as name) + Domain name + + + uri + string + URI of the Service units @@ -1536,13 +1576,19 @@ http://docbook.org/ns/docbook " id - guid + string Unique ID isMaster boolean - Is unit is master domain? + true for primary domain controller, + false otherwise + + + address + string + Unit address location @@ -1604,9 +1650,9 @@ http://docbook.org/ns/docbook " X-Configuration-Session - UUID + string no - UUID of valid configuration session + ID of valid configuration session @@ -1628,13 +1674,17 @@ http://docbook.org/ns/docbook " "name": "acme.dc", "created": "2010-11-30T03:23:42Z", "updated": "2010-11-30T03:23:44Z", + "uri": "10.0.0.2", "units": [{ "id": "d08887df15b94178b244904b506fe85b", "isMaster": true, + "address": "10.0.0.2", "location": "west-dc" - }, { + }, + { "id": "dcf0de317e7046bea555539f19b8ea84", "isMaster": false, + "address": "10.0.0.3", "location": "west-dc" }] }] @@ -1680,7 +1730,7 @@ http://docbook.org/ns/docbook " domain string yes - Domain name (same as name) + Domain name units @@ -1711,7 +1761,8 @@ http://docbook.org/ns/docbook " isMaster boolean yes - Is unit is master domain? + true for primary domain controller, + false otherwise recoveryPassword @@ -1777,9 +1828,9 @@ http://docbook.org/ns/docbook " X-Configuration-Session - UUID + string yes - UUID of valid configuration session + ID of valid configuration session @@ -1858,7 +1909,7 @@ http://docbook.org/ns/docbook " id - guid + string Unique ID @@ -1879,10 +1930,18 @@ http://docbook.org/ns/docbook " format + + uri + string + URI of the Service + domain string - Domain name (same as name) + Domain name. + This attribute may be empty/null/omitted + if machine is not a domain member + units @@ -1908,13 +1967,13 @@ http://docbook.org/ns/docbook " id - guid + string Unique ID - endpoint - object - Unit Endpoint + address + string + Unit address location @@ -1925,30 +1984,6 @@ http://docbook.org/ns/docbook " - - Web Server Unit Endpoint Object - - - - - - - Attribute - Type - Description - - - - - host - string - Host address for IIS Management Console - connection - - - - -
Call @@ -1999,9 +2034,9 @@ http://docbook.org/ns/docbook " X-Configuration-Session - UUID + string no - UUID of valid configuration session + ID of valid configuration session @@ -2025,11 +2060,10 @@ http://docbook.org/ns/docbook " "created": "2010-11-30T03:23:42Z", "updated": "2010-11-30T03:23:44Z", "domain": "ACME", + "uri": "http://10.0.0.2", "units": [{ "id": "1bf3491c409b4541b6f18ea5988a6437", - "endpoint": { - "host": "10.0.0.2" - }, + "address": "10.0.0.2", "location": "west-dc" }] }, @@ -2038,12 +2072,11 @@ http://docbook.org/ns/docbook " "name": "backend", "created": "2010-11-30T03:23:42Z", "updated": "2010-11-30T03:23:44Z", - "domain": "ACME" , + "domain": "ACME", + "uri": "http://10.0.0.3", "units": [{ "id": "eb32f97866d24001baa430cb34e4049f", - "endpoint": { - "host": "10.0.0.3" - }, + "address": "10.0.0.3", "location": "west-dc" }] } @@ -2080,8 +2113,8 @@ http://docbook.org/ns/docbook " domain string - yes - Domain name (same as name) + no + Domain name units @@ -2124,7 +2157,7 @@ http://docbook.org/ns/docbook " POST /environments/<id>/webServers Call - + @@ -2162,9 +2195,9 @@ http://docbook.org/ns/docbook " X-Configuration-Session - UUID + string yes - UUID of valid configuration session + ID of valid configuration session @@ -2208,7 +2241,1120 @@ http://docbook.org/ns/docbook " +
+ ASP.NET Application API + This section describes API calls for managing ASP.NET + Applications +
+ Get a List of existing ASP.NET Applications +
+ ASP.NET Application Object + + + + + + + Attribute + Type + Description + + + + + id + string + Unique ID + + + name + string + User-friendly name + + + created + datetime + Creation date and time in ISO format + + + + updated + datetime + Modification date and time in ISO + format + + + + repository + string + URL of git repository containing the + application source files + + + uri + string + URI of the Service + + + domain + string + Domain name. + This attribute may be empty/null/omitted + if machine is not a domain member + + + + units + object + ASP.NET Application Unit + object + + + +
+ + ASP.NET Application Unit Object + + + + + + + Attribute + Type + Description + + + + + id + string + Unique ID + + + address + string + Unit address + + + location + string + AvailabilityZone or specific + physical datacenter. + + + + +
+
+ Call + + GET /environments/<id>/aspNetApps + Call + + + + + + + + Method + URI + Description + + + + + GET + /environments/<id>/aspNetApps + Get a list of existing ASP.NET + Applications + + + + +
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + string + no + ID of valid configuration session + + + +
+
+
+ Payload + None +
+
+ Returns + This call returns list of ASP.NET Applications: + + + + +
+
+
+ Create ASP.NET Application instance + + ASP.NET Application Object + + + + + + + + Attribute + Type + Required + Description + + + + + name + string + yes + User-friendly name + + + repository + string + yes + URL of git repository containing the + application source files + + + domain + string + no + Domain name + + + units + object + yes + ASP.NET Application Unit object + + + +
+ + ASP.NET Application Unit Object + + + + + + + + Attribute + Type + Required + Description + + + + + location + string + yes + AvailabilityZone or specific physical datacenter. + + + + +
+
+ Call + + POST /environments/<id>/aspNetApps + Call + + + + + + + + Method + URI + Description + + + + + POST + /environments/<id>/aspNetApps + Create new ASP.NET Application + + + +
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + string + yes + ID of valid configuration session + + + +
+
+
+ Payload + + + +
+
+ Returns + This call returns created ASP.NET Application: + + + + +
+
+
+
+ Web Server Farm API + This section describes API calls for managing Web Server + (IIS) Web Farm services +
+ Get a List of existing Web Server Farms + + Web Server Farm Object + + + + + + + Attribute + Type + Description + + + + + id + string + Unique ID + + + name + string + User-friendly name + + + created + datetime + Creation date and time in ISO format + + + + updated + datetime + Modification date and time in ISO + format + + + + uri + string + URI of the Service + + + loadBalancerPort + integer + Port number of the Farm + + + domain + string + Domain name. + This attribute may be empty/null/omitted + if machine is not a domain member + + + + units + object + Web Server Farm Unit + object + + + +
+ + Web Server Farm Unit Object + + + + + + + Attribute + Type + Description + + + + + id + string + Unique ID + + + location + string + AvailabilityZone or specific + physical datacenter. + + + + +
+
+ Call + + GET /environments/<id>/webServerFarms + Call + + + + + + + + Method + URI + Description + + + + + GET + /environments/<id>/webServerFarms + Get a list of existing + Web Server Farms + + + + +
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + string + no + ID of valid configuration session + + + +
+
+
+ Payload + None +
+
+ Returns + This call returns list of Web Server Farms: + + + + +
+
+
+ Create Web Server Farm instance + + Web Server Farm Object + + + + + + + + Attribute + Type + Required + Description + + + + + name + string + yes + User-friendly name + + + loadBalancerPort + integer + yes + Port number for the Farm + + + domain + string + no + Domain name + + + units + object + yes + Web Server Farm Unit object + + + +
+ + Web Server Farm Unit Object + + + + + + + + Attribute + Type + Required + Description + + + + + location + string + yes + AvailabilityZone or specific physical datacenter. + + + + +
+
+ Call + + POST /environments/<id>/webServerFarms + Call + + + + + + + + Method + URI + Description + + + + + POST + /environments/<id>/webServerFarms + Create new Web Server Farm + + + +
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + string + yes + ID of valid configuration session + + + +
+
+
+ Payload + + + +
+
+ Returns + This call returns created Web Server Farm: + + + + +
+
+
+
+
+ ASP.NET Application Farm API + This section describes API calls for managing ASP.NET + Web Farm Application Services +
+ Get a List of existing ASP.NET Application Farms + + ASP.NET Application Farm Object + + + + + + + Attribute + Type + Description + + + + + id + string + Unique ID + + + name + string + User-friendly name + + + created + datetime + Creation date and time in ISO format + + + + updated + datetime + Modification date and time in ISO + format + + + + uri + string + URI of the Service + + + repository + string + URL of git repository containing the + application source files + + + loadBalancerPort + integer + Port number of the Farm + + + domain + string + Domain name. + This attribute may be empty/null/omitted + if machine is not a domain member + + + + units + object + ASP.NET Application Farm Unit + object + + + +
+ + ASP.NET Application Farm Unit Object + + + + + + + Attribute + Type + Description + + + + + id + string + Unique ID + + + address + string + Unit address + + + location + string + AvailabilityZone or specific + physical datacenter. + + + + +
+
+ Call + + GET /environments/<id>/aspNetAppFarms + Call + + + + + + + + Method + URI + Description + + + + + GET + /environments/<id>/aspNetAppFarms + Get a list of existing + ASP.NET Application Farms + + + + +
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + string + no + ID of valid configuration session + + + +
+
+
+ Payload + None +
+
+ Returns + This call returns list of ASP.NET Application Farms: + + + + +
+
+
+ Create ASP.NET Application Farm instance + + ASP.NET Application Farm Object + + + + + + + + Attribute + Type + Required + Description + + + + + name + string + yes + User-friendly name + + + repository + string + yes + URL of git repository containing the + application source files + + + loadBalancerPort + integer + yes + Port number for the Farm + + + domain + string + no + Domain name + + + units + object + yes + ASP.NET Application Farm Unit object + + + +
+ + ASP.NET Application Farm Unit Object + + + + + + + + Attribute + Type + Required + Description + + + + + location + string + yes + AvailabilityZone or specific physical datacenter. + + + + +
+
+ Call + + POST /environments/<id>/aspNetAppFarms + Call + + + + + + + + Method + URI + Description + + + + + POST + /environments/<id>/aspNetAppFarms + Create new ASP.NET Application Farm + + + +
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + string + yes + ID of valid configuration session + + + +
+
+
+ Payload + + + +
+
+ Returns + This call returns created ASP.NET Application Farm: + + + + +
+
+
+ Installation Guide