openstack/deb-murano
Code Issues Proposed changes

murano documentation and cleanup

Browse Source 
project name muranos official name and capitalization changed
see: https://wiki.openstack.org/wiki/Documentation/Conventions
removed unnecessary capitalizations throughout the docs
corrected grammar and vocabulary to follow standards
added “an” instead of “a” before words that start with vowels
corrected spelling throughout several docs

Change-Id: I43678b35bc8df289468900133816607a9fbda1cc
This commit is contained in:
Shilla Saebi 2015-05-27 12:51:05 -04:00
parent 46362edb04
commit 304843e309
4 changed files with 50 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/specification/index.rst
View File

@ -22,9 +22,9 @@ General information
* **Introduction** * **Introduction**
Murano Service API is a programmatic interface used for interaction with The murano service API is a programmatic interface used for interaction with
Murano. Other interaction mechanisms like Murano Dashboard or Murano CLI murano. Other interaction mechanisms like the murano dashboard or the murano CLI
should use API as underlying protocol for interaction. should use the API as an underlying protocol for interaction.
* **Allowed HTTPs requests** * **Allowed HTTPs requests**
@ -53,9 +53,9 @@ General information
* **Authentication** * **Authentication**
All requests include a Keystone authentication token header All requests include a keystone authentication token header
(X-Auth-Token). Clients must authenticate with Keystone before (X-Auth-Token). Clients must authenticate with keystone before
interacting with the Murano service. interacting with the murano service.
.. include:: murano-api.rst .. include:: murano-api.rst
.. include:: murano-repository.rst .. include:: murano-repository.rst

64
doc/source/specification/murano-api.rst
View File

@ -18,33 +18,33 @@ Glossary
* **Environment** * **Environment**
Environment is a set of applications managed by a single tenant. They could be related logically with each other or not. The environment is a set of applications managed by a single tenant. They could be related logically with each other or not.
Applications within single Environment may comprise some complex configuration while applications in different Environments are always Applications within a single environment may comprise of complex configuration while applications in different environments are always
independent from one another. Each Environment is associated with single independent from one another. Each environment is associated with a single
OpenStack project (tenant). OpenStack project (tenant).
.. _`sessions`: .. _`sessions`:
* **Session** * **Session**
Since Murano environment are available for local modification for different users and from different locations, it's needed to store local modifications somewhere. Since murano environments are available for local modification for different users and from different locations, it's needed to store local modifications somewhere.
So sessions were created to provide this opportunity. After user adds application to the environment - new session is created. Sessions were created to provide this opportunity. After a user adds an application to the environment - a new session is created.
After user sends environment to deploy, session with set of applications changes status to *deploying* and all other open sessions for that environment becomes invalid. After a user sends an environment to deploy, a session with a set of applications changes status to *deploying* and all other open sessions for that environment become invalid.
One session could be deployed only once. One session could be deployed only once.
* **Object Model** * **Object Model**
Applications are defined in MuranoPL object model, which is defined as JSON object. Applications are defined in MuranoPL object model, which is defined as a JSON object.
Murano API doesn't know anything about it. The murano API doesn't know anything about it.
* **Package** * **Package**
A .zip archive, containing instructions for an application deployment. A .zip archive, containing instructions for an application deployment.
* **Environment-Template** * **Environment-Template**
The Environment template is the specification of a set of applications managed by a single tenant, which are The environment template is the specification of a set of applications managed by a single tenant, which are
related each other. The environment template is stored in a environment template catalogue, and it can be related to each other. The environment template is stored in an environment template catalog, and it can be
managed by the user (creation, deletion, updating...). Finally, it can be deployed on Openstack by translating managed by the user (creation, deletion, updating). Finally, it can be deployed on OpenStack by translating
into an environment. into an environment.
@ -82,7 +82,7 @@ Environment API
| 401 | User is not authorized to perform the operation | | 401 | User is not authorized to perform the operation |
+----------------+-----------------------------------------------------------+ +----------------+-----------------------------------------------------------+
List Environments List environments
----------------- -----------------
*Request* *Request*
@ -98,7 +98,7 @@ List Environments
*Response* *Response*
This call returns list of environments. Only the basic properties are This call returns a list of environments. Only the basic properties are
returned. returned.
:: ::
@ -128,7 +128,7 @@ returned.
] ]
} }
Create Environment Create environment
------------------ ------------------
+----------------------+------------+--------------------------------------------------------+ +----------------------+------------+--------------------------------------------------------+
@ -165,7 +165,7 @@ Create Environment
} }
Update Environment Update environment
------------------ ------------------
+----------------------+------------+--------------------------------------------------------+ +----------------------+------------+--------------------------------------------------------+
@ -219,12 +219,12 @@ Update Environment
| 409 | Environment with specified name already exists | | 409 | Environment with specified name already exists |
+----------------+-----------------------------------------------------------+ +----------------+-----------------------------------------------------------+
Get Environment Details Get environment details
----------------------- -----------------------
*Request* *Request*
Return information about environment itself and about applications, including to this environment. Return information about the environment itself and about applications, including this environment.
+----------+----------------------------------+-----------------------------------+----------------------------------+ +----------+----------------------------------+-----------------------------------+----------------------------------+
| Method | URI | Header | Description | | Method | URI | Header | Description |
@ -277,7 +277,7 @@ Return information about environment itself and about applications, including to
"id": "20d4a012628e4073b48490a336a8acbf" "id": "20d4a012628e4073b48490a336a8acbf"
} }
Delete Environment Delete environment
------------------ ------------------
*Request* *Request*
@ -289,7 +289,7 @@ Delete Environment
| DELETE | /environments/{id} | Remove specified Environment. | | DELETE | /environments/{id} | Remove specified Environment. |
+----------+----------------------------------+----------------------------------+ +----------+----------------------------------+----------------------------------+
Environment Configuration API Environment configuration API
============================= =============================
Multiple `sessions`_ could be opened for one environment simultaneously, but only one session going Multiple `sessions`_ could be opened for one environment simultaneously, but only one session going
@ -318,7 +318,7 @@ User could not open new session for environment that in
| | | deployed | | | | deployed |
+----------------------+------------+-------------------------------------------+ +----------------------+------------+-------------------------------------------+
Configure Environment / Open session Configure environment / open session
------------------------------------ ------------------------------------
During this call new working session is created, and session ID should be sent in a request header with name ``X-Configuration-Session``. During this call new working session is created, and session ID should be sent in a request header with name ``X-Configuration-Session``.
@ -359,10 +359,10 @@ During this call new working session is created, and session ID should be sent i
| | deploying status | | | deploying status |
+----------------+-----------------------------------------------------------+ +----------------+-----------------------------------------------------------+
Deploy Session Deploy session
-------------- --------------
With this request all local changes made within environment start to deploy on Openstack. With this request all local changes made within the environment start to deploy on OpenStack.
*Request* *Request*
@ -386,7 +386,7 @@ With this request all local changes made within environment start to deploy on O
| 403 | Session is already deployed or deployment is in progress | | 403 | Session is already deployed or deployment is in progress |
+----------------+-----------------------------------------------------------+ +----------------+-----------------------------------------------------------+
Get Session Details Get session details
------------------- -------------------
*Request* *Request*
@ -423,7 +423,7 @@ Get Session Details
| 403 | Session is invalid | | 403 | Session is invalid |
+----------------+-----------------------------------------------------------+ +----------------+-----------------------------------------------------------+
Delete Session Delete session
-------------- --------------
*Request* *Request*
@ -447,7 +447,7 @@ Delete Session
| 403 | Session is in deploying state and could not be deleted | | 403 | Session is in deploying state and could not be deleted |
+----------------+-----------------------------------------------------------+ +----------------+-----------------------------------------------------------+
Environment Deployments API Environment deployments API
=========================== ===========================
Environment deployment API allows to track changes of environment status, deployment events and errors. Environment deployment API allows to track changes of environment status, deployment events and errors.
@ -534,19 +534,19 @@ Returns information about all deployments of the specified environment.
| 401 | User is not authorized to access this environment | | 401 | User is not authorized to access this environment |
+----------------+-----------------------------------------------------------+ +----------------+-----------------------------------------------------------+
Application Management API Application management API
========================== ==========================
All applications should be created within an environment and all environment modifications are held within the session. All applications should be created within an environment and all environment modifications are held within the session.
Local changes apply only after successful deployment of an environment session. Local changes apply only after successful deployment of an environment session.
Get Application Details Get application details
----------------------- -----------------------
Using GET requests to applications endpoint user works with list containing all Using GET requests to applications endpoint user works with list containing all
applications for specified environment. User can request whole list, applications for specified environment. A user can request a whole list,
specific application, or specific attribute of specific application using tree specific application, or specific attribute of a specific application using tree
traversing. To request specific application, user should add to endpoint part traversing. To request a specific application, the user should add to endpoint part
an application id, e.g.: */environments/<env_id>/services/<application_id>*. For an application id, e.g.: */environments/<env_id>/services/<application_id>*. For
selection of specific attribute on application, simply appending part with selection of specific attribute on application, simply appending part with
attribute name will work. For example to request application name, user attribute name will work. For example to request application name, user
@ -596,7 +596,7 @@ should use next endpoint: */environments/<env_id>/services/<application_id>/name
POST applications POST applications
----------------- -----------------
New application can be added to the Murano environment using session. New application can be added to the murano environment using session.
Result JSON is calculated in Murano dashboard, which based on `UI definition <Dynamic UI Spec>`_ Result JSON is calculated in Murano dashboard, which based on `UI definition <Dynamic UI Spec>`_
*Request* *Request*
@ -686,7 +686,7 @@ Statistic API
Statistic API intends to provide billing feature Statistic API intends to provide billing feature
Instance Environment Statistics Instance environment statistics
------------------------------- -------------------------------
*Request* *Request*

16
doc/source/specification/murano-env-temp.rst
View File

@ -13,10 +13,10 @@
License for the specific language governing permissions and limitations License for the specific language governing permissions and limitations
under the License. under the License.
Environment Template API Environment template API
======================== ========================
Manage environment template definitions in Murano. It is possible to create, update, delete and deploy into Openstack by translating Manage environment template definitions in Murano. It is possible to create, update, delete and deploy into OpenStack by translating
it into an environment. In addition, applications can be added or delete to the environment template. it into an environment. In addition, applications can be added or delete to the environment template.
**Environment Template Properties** **Environment Template Properties**
@ -67,7 +67,7 @@ List Environments Templates
*Response* *Response*
This call returns list of environment templates. Only the basic properties are This call returns a list of environment templates. Only the basic properties are
returned. returned.
:: ::
@ -96,7 +96,7 @@ returned.
} }
Create Environment Template Create environment template
--------------------------- ---------------------------
+----------------------+------------+---------------------------------------------------------+ +----------------------+------------+---------------------------------------------------------+
@ -145,8 +145,8 @@ Create Environment Template
+----------------+-----------------------------------------------------------+ +----------------+-----------------------------------------------------------+
Get Environment Templates Details Get environment templates details
----------------------- ---------------------------------
*Request* *Request*
@ -156,7 +156,7 @@ environment template.
+----------+--------------------------------+-------------------------------------------------+ +----------+--------------------------------+-------------------------------------------------+
| Method | URI | Description | | Method | URI | Description |
+==========+================================+=================================================+ +==========+================================+=================================================+
| GET | /templates/{env-temp-id} | Obtains the enviroment template information | | GET | /templates/{env-temp-id} | Obtains the environment template information |
+----------+--------------------------------+-------------------------------------------------+ +----------+--------------------------------+-------------------------------------------------+
* `env-temp-id` - environment template ID, required * `env-temp-id` - environment template ID, required
@ -192,7 +192,7 @@ environment template.
| 404 | The environment template does not exit | | 404 | The environment template does not exit |
+----------------+-----------------------------------------------------------+ +----------------+-----------------------------------------------------------+
Delete Environment Template Delete environment template
--------------------------- ---------------------------
*Request* *Request*

8
doc/source/specification/murano-repository.rst
View File

@ -13,7 +13,7 @@
License for the specific language governing permissions and limitations License for the specific language governing permissions and limitations
under the License. under the License.
Application Catalog API Application catalog API
======================= =======================
Manage application definitions in the Application Catalog. Manage application definitions in the Application Catalog.
@ -220,13 +220,13 @@ Display details for a package.
**Response 403** **Response 403**
* In attempt to get non-public package by user whose tenant is not an owner of this package. * In attempt to get a non-public package by a user whose tenant is not an owner of this package.
**Response 404** **Response 404**
* In case specified package id doesn't exist. * In case the specified package id doesn't exist.
Update a Package Update a package
================ ================
`/v1/catalog/packages/{id} [PATCH]` `/v1/catalog/packages/{id} [PATCH]`