diff --git a/src/murano-manual/src/docbkx/murano-manual.xml b/src/murano-manual/src/docbkx/murano-manual.xml index e1b59fd..4d88c47 100644 --- a/src/murano-manual/src/docbkx/murano-manual.xml +++ b/src/murano-manual/src/docbkx/murano-manual.xml @@ -626,60 +626,64 @@ http://docbook.org/ns/docbook " This section describes API calls for Environment management. - - Environment Object - - - - - - - Attribute - Type - Description - - - - - id - guid - 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 - - - - tenant_id - guid - Open Stack tenant id - - - status - string - Deployment status: draft, pending, - inprogress, finished - - - - -
Get a List of existing Environments + + Environment Object + + + + + + + Attribute + Type + Description + + + + + id + guid + 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 + + + + tenant_id + guid + Open Stack tenant id + + + version + int + Current version + + + status + string + Deployment status: ready, pending, deploying + + + + +
Call @@ -729,14 +733,18 @@ http://docbook.org/ns/docbook " "name": "dc1", "created": "2010-11-30T03:23:42Z", "updated": "2010-11-30T03:23:44Z", - "tenant_id": "0849006f7ce94961b3aab4e46d6f229a" + "tenant_id": "0849006f7ce94961b3aab4e46d6f229a", + "version": 1, + "status": "ready" }, { "id": "c697bd2429304820a928d145aa42af59", "name": "dc2", "created": "2010-11-30T03:23:42Z", "updated": "2010-11-30T03:23:44Z", - "tenant_id": "0849006f7ce94961b3aab4e46d6f229a" + "tenant_id": "0849006f7ce94961b3aab4e46d6f229a", + "version": 2, + "status": "deploying" } ] } @@ -747,11 +755,36 @@ http://docbook.org/ns/docbook "
Create Environment instance +
+ Environment Object + + + + + + + + Attribute + Type + Required + Description + + + + + name + string + yes + User-friendly name + + + +
Call POST /environments Call - @@ -796,7 +829,8 @@ http://docbook.org/ns/docbook " "name": "env1", "created": "2010-11-30T03:23:42Z", "updated": "2010-11-30T03:23:44Z", - "tenant_id": "0849006f7ce94961b3aab4e46d6f229a" + "tenant_id": "0849006f7ce94961b3aab4e46d6f229a", + "version": 0 } ]]> @@ -805,6 +839,31 @@ http://docbook.org/ns/docbook "
Update Environment Instance +
+ Environment Object + + + + + + + + Attribute + Type + Required + Description + + + + + name + string + yes + User-friendly name + + + +
Call @@ -856,7 +915,8 @@ http://docbook.org/ns/docbook " "name": "env1-changed", "created": "2010-11-30T03:23:42Z", "updated": "2010-11-30T03:23:44Z", - "tenant_id": "0849006f7ce94961b3aab4e46d6f229a" + "tenant_id": "0849006f7ce94961b3aab4e46d6f229a", + "version": 0 } ]]> @@ -904,16 +964,37 @@ http://docbook.org/ns/docbook "
Returns - This call returns modified environment object: + This call returns environment object with underlying services: @@ -964,11 +1045,10 @@ http://docbook.org/ns/docbook "
Environment Configuration API - Only one Environment can be configured at a time by only - one user. This behavior archived by opening "configuration - session" for some Environment by user, and locking this - Environment for changes by other users. Only one open - session per Environment is available. + Multiple sessions could be opened for one environment simultaneously, but only one session going + to be deployed. First session that starts deploying is going to be deployed; other ones become + invalid and could not be deployed at all. User could not open new session for environment that in + `deploying` state (that’s why we call it “almost lock free” model).
Configuration Session Object @@ -1014,6 +1094,11 @@ http://docbook.org/ns/docbook " guidSession owner guid + + version + int + Environment version for which configuration session is opened + state string @@ -1025,80 +1110,8 @@ http://docbook.org/ns/docbook "
- Get a List of Sessions - Only one open session can be for one Environment. - -
- Call - - GET /environments/<id>/sessions Call - - - - - - - - Method - URI - Description - - - - - GET - /environments/<id>/sessions - Get a list of open sessions - - - - -
-
-
- Payload - None -
-
- Returns - This call returns list of open sessions: - - - - -
-
-
- Open session - During this call new working session is created, and - session ID should be sent in header - (X-Configuration-Session) to all next API calls. - + Configure Environment / Open session + During this call new working session is created, and session ID should be sent in header (X-Configuration-Session) to all next API calls.
Call @@ -1124,8 +1137,7 @@ http://docbook.org/ns/docbook " POST /environments/<id>/configure - Creating new configuration - change session + Creating new configuration session @@ -1147,6 +1159,7 @@ http://docbook.org/ns/docbook " "created": "2010-11-30T03:23:42Z", "updated": "2010-11-30T03:23:54Z", "user_id": "d7b501094caf4daab08469663a9e1a2b", + "version": 12, "state": "open" } ]]> @@ -1194,20 +1207,7 @@ http://docbook.org/ns/docbook "
Returns - This call returns deployed session: - - - - + None
@@ -1260,6 +1260,7 @@ http://docbook.org/ns/docbook " "created": "2010-11-30T03:23:42Z", "updated": "2010-11-30T03:23:54Z", "user_id": "d7b501094caf4daab08469663a9e1a2b", + "version": 0, "state": "deploying" } ]]> @@ -1357,13 +1358,6 @@ http://docbook.org/ns/docbook " format - - configuration - string - AD configuration: site, standalone, - inTree - - domain string @@ -1443,6 +1437,31 @@ http://docbook.org/ns/docbook "
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + UUID + no + UUID of valid configuration session + + + +
Payload @@ -1460,7 +1479,6 @@ http://docbook.org/ns/docbook " "name": "acme.dc", "created": "2010-11-30T03:23:42Z", "updated": "2010-11-30T03:23:44Z", - "configuration": "standalone", "units": [{ "id": "d08887df15b94178b244904b506fe85b", "isMaster": true, @@ -1481,14 +1499,16 @@ http://docbook.org/ns/docbook " Create Active Directory instance Active Directory Object - + - + + Attribute Type + Required Description @@ -1496,18 +1516,13 @@ http://docbook.org/ns/docbook " name string + yes Domain name - - configuration - string - AD configuration: site, standalone, - inTree - - adminPassword string + yes Password from domain administrator account @@ -1515,11 +1530,13 @@ http://docbook.org/ns/docbook " domain string + yes Domain name (same as name) units object + yes Active Directory Unit object @@ -1527,14 +1544,16 @@ http://docbook.org/ns/docbook "
Active Directory Unit Object - + - + + Attribute Type + Required Description @@ -1542,19 +1561,20 @@ http://docbook.org/ns/docbook " isMaster boolean + yes Is unit is master domain? recoveryPassword string + yes Recovery password location string - AvailabilityZone or specific - physical datacenter. - + yes + AvailabilityZone or specific physical datacenter. @@ -1590,6 +1610,31 @@ http://docbook.org/ns/docbook "
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + UUID + yes + UUID of valid configuration session + + + +
Payload @@ -1597,7 +1642,6 @@ http://docbook.org/ns/docbook " - - -
-
-
- Update Active Directory instance - - Active Directory Object - - - - - - - Attribute - Type - Description - - - - - id - guid - Unique ID - - - name - string - Domain name - - - configuration - string - AD configuration: site, standalone, - inTree - - - - adminPassword - string - Password from domain administrator - account - - - - domain - string - Domain name (same as name) - - - units - object - Active Directory Unit object - - - -
- - Active Directory Unit Object - - - - - - - Attribute - Type - Description - - - - - id - guid - Unique ID - - - isMaster - boolean - Is unit is master domain? - - - recoveryPassword - string - Recovery password - - - location - string - AvailabilityZone or specific - physical datacenter. - - - - -
-
- Call - - PUT /environments/<id>/activeDirectories/<serviceId> - Call - - - - - - - - Method - URI - Description - - - - - PUT - /environments/<id>/activeDirectories/<serviceId> - Update existing Active - Directory - - - - -
-
-
- Payload - - - -
-
- Returns - This call returns updated active directory - domain: - - - - -
-
-
- Get Information about Active Directory instance - - - Active Directory Object - - - - - - - Attribute - Type - Description - - - - - id - guid - Unique ID - - - name - string - Domain name - - - created - datetime - Creation date and time in ISO - format - - - - updated - datetime - Modification date and time in ISO - format - - - - configuration - string - AD configuration: site, standalone, - inTree - - - - domain - string - Domain name (same as name) - - - units - object - Active Directory Unit object - - - -
- - Active Directory Unit Object - - - - - - - Attribute - Type - Description - - - - - id - guid - Unique ID - - - isMaster - boolean - Is unit is master domain? - - - location - string - AvailabilityZone or specific - physical datacenter. - - - - -
-
- Call - - GET /environments/<id>/activeDirectories/<serviceId> - Call - - - - - - - - Method - URI - Description - - - - - GET - /environments/<id>/activeDirectories/<serviceId> - Return specified Active - Directory instance - - - - -
-
-
- Payload - None -
-
- Returns - This call returns modified environment object: - -
Web Server API - This section describes API calls for managing Windows - web-server software – IIS. - - - Web Server Object - - - - - - - Attribute - Type - Description - - - - - id - guid - 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 - - - - domain - string - Domain name (same as name) - - - units - object - Web Server Unit object - - - -
- - Web Server Unit Object - - - - - - - Attribute - Type - Description - - - - - id - guid - Unique ID - - - endpoint - object - Unit Endpoint - - - location - string - AvailabilityZone or specific physical - datacenter. - - - - -
- - Web Server Unit Endpoint Object - - - - - - - Attribute - Type - Description - - - - - host - string - Host address for IIS Management Console - connection - - - - -
+ This section describes API calls for managing Windows web-server software – IIS.
Get a List of existing Web Servers + + Web Server Object + + + + + + + Attribute + Type + Description + + + + + id + guid + 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 + + + + domain + string + Domain name (same as name) + + + units + object + Web Server Unit object + + + +
+ + Web Server Unit Object + + + + + + + Attribute + Type + Description + + + + + id + guid + Unique ID + + + endpoint + object + Unit Endpoint + + + location + string + AvailabilityZone or specific physical datacenter. + + + + +
+ + Web Server Unit Endpoint Object + + + + + + + Attribute + Type + Description + + + + + host + string + Host address for IIS Management Console + connection + + + + +
Call @@ -2129,6 +1832,31 @@ http://docbook.org/ns/docbook "
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + UUID + no + UUID of valid configuration session + + + +
Payload @@ -2178,20 +1906,79 @@ http://docbook.org/ns/docbook "
Create Web Server instance + + Web Server Object + + + + + + + + Attribute + Type + Required + Description + + + + + name + string + yes + User-friendly name + + + domain + string + yes + Domain name (same as name) + + + units + object + yes + Web Server Unit object + + + +
+ + Web Server Unit Object + + + + + + + + Attribute + Type + Required + Description + + + + + location + string + yes + AvailabilityZone or specific physical datacenter. + + + + +
Call POST /environments/<id>/webServers Call - - - - + + + + Method @@ -2208,6 +1995,31 @@ http://docbook.org/ns/docbook "
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + UUID + yes + UUID of valid configuration session + + + +
Payload @@ -2246,144 +2058,6 @@ http://docbook.org/ns/docbook " "id": "1bf3491c409b4541b6f18ea5988a6437", "location": "west-dc" }] -} - ]]> - - -
-
-
- Update Web Server Instance -
- Call - - PUT /environments/<id>/webServers/<serviceId> - Call - - - - - - - - Method - URI - Description - - - - - PUT - /environments/<id>/webServers/<serviceId> - Update properties of WebServer - instance - - - - -
-
-
- Payload - - - -
-
- Returns - This call returns modified web server object: - - - - -
-
-
- Get Web Server Instance Detailed Information -
- Call - - GET /environments/<id>/webServers/<serviceId> - Call - - - - - - - - Method - URI - Description - - - - - GET - /environments/<id>/webServers/<serviceId> - Returns detailed information - about Web Server - - - - -
-
-
- Payload - None -
-
- Returns - This call returns modified environment object: - -