Merge "Revises json to JSON, yaml to YAML and yaql to YAQL in documents"
This commit is contained in:
commit
0d1a6fab02
@ -100,7 +100,7 @@ package.
|
|||||||
-------
|
-------
|
||||||
|
|
||||||
In Liberty, murano was updated to use `yaql 1.0.0`.
|
In Liberty, murano was updated to use `yaql 1.0.0`.
|
||||||
The new version of yaql allows you to use a number of new functions and
|
The new version of YAQL allows you to use a number of new functions and
|
||||||
features that help to increase the speed of developing new applications.
|
features that help to increase the speed of developing new applications.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
@ -147,8 +147,8 @@ unit tests:
|
|||||||
Methods:
|
Methods:
|
||||||
initialize:
|
initialize:
|
||||||
Body:
|
Body:
|
||||||
# Object model can be loaded from json file, or provided
|
# Object model can be loaded from JSON file, or provided
|
||||||
# directly in MuranoPL code as a yaml insertion.
|
# directly in MuranoPL code as a YAML insertion.
|
||||||
- $.appJson: new(sys:Resources).json('tomcat-for-mock.json')
|
- $.appJson: new(sys:Resources).json('tomcat-for-mock.json')
|
||||||
- $.heatOutput: new(sys:Resources).json('output.json')
|
- $.heatOutput: new(sys:Resources).json('output.json')
|
||||||
- $.log: logger('test')
|
- $.log: logger('test')
|
||||||
|
@ -18,7 +18,7 @@ Specific information about *bundle-import* command can be found at
|
|||||||
Bundle structure
|
Bundle structure
|
||||||
~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Bundle description is a json structure, that contains list of packages
|
Bundle description is a JSON structure, that contains list of packages
|
||||||
in the bundle and bundle version. Here is the example:
|
in the bundle and bundle version. Here is the example:
|
||||||
|
|
||||||
.. code-block:: javascript
|
.. code-block:: javascript
|
||||||
|
@ -128,7 +128,7 @@ at least one argument.
|
|||||||
|
|
||||||
Extension methods can also be written in Python just the same way as static
|
Extension methods can also be written in Python just the same way as static
|
||||||
methods. However one should be careful in method declaration and use precise
|
methods. However one should be careful in method declaration and use precise
|
||||||
yaql specification of the type of first method argument otherwise the method
|
YAQL specification of the type of first method argument otherwise the method
|
||||||
will become an extension of any type.
|
will become an extension of any type.
|
||||||
|
|
||||||
To turn Python static method into extension method it must be decorated with
|
To turn Python static method into extension method it must be decorated with
|
||||||
|
@ -88,8 +88,8 @@ Application and Templates
|
|||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
The Application section describes an *application object model*.
|
The Application section describes an *application object model*.
|
||||||
This model will be translated into json, and an application will be
|
This model will be translated into JSON, and an application will be
|
||||||
deployed according to that json. The application section should
|
deployed according to that JSON. The application section should
|
||||||
contain all necessary keys that are required by the murano-engine to
|
contain all necessary keys that are required by the murano-engine to
|
||||||
deploy an application. Note that the system section of the object model goes
|
deploy an application. Note that the system section of the object model goes
|
||||||
under the *?*. So murano recognizes that instead of simple value,
|
under the *?*. So murano recognizes that instead of simple value,
|
||||||
@ -204,7 +204,7 @@ field attributes. The most common attributes are the following:
|
|||||||
* **label** - name, that will be displayed in the form; defaults to **name**
|
* **label** - name, that will be displayed in the form; defaults to **name**
|
||||||
being capitalized.
|
being capitalized.
|
||||||
* **description** - description, that will be displayed in the description area.
|
* **description** - description, that will be displayed in the description area.
|
||||||
Use yaml line folding character ``>-`` to keep the correct formatting during
|
Use YAML line folding character ``>-`` to keep the correct formatting during
|
||||||
data transferring.
|
data transferring.
|
||||||
* **descriptionTitle** - title of the description, defaults to **label**;
|
* **descriptionTitle** - title of the description, defaults to **label**;
|
||||||
displayed in the description area
|
displayed in the description area
|
||||||
|
@ -22,7 +22,7 @@ The application package root folder should contain the following:
|
|||||||
deployment located in it.
|
deployment located in it.
|
||||||
|
|
||||||
**UI** folder
|
**UI** folder
|
||||||
contains the dynamic UI yaml definitions.
|
contains the dynamic UI YAML definitions.
|
||||||
|
|
||||||
**logo.png** file (optional)
|
**logo.png** file (optional)
|
||||||
is an image file associated to your application.
|
is an image file associated to your application.
|
||||||
|
@ -15,7 +15,7 @@ It is fairly easy to set up your own murano package repository. To do so you nee
|
|||||||
|
|
||||||
When importing an application by name, the client appends any version info, if present to the application name, ``.zip`` file extension and searches for that file in the ``apps`` directory.
|
When importing an application by name, the client appends any version info, if present to the application name, ``.zip`` file extension and searches for that file in the ``apps`` directory.
|
||||||
|
|
||||||
When importing a bundle by name, the client appends ``.bundle`` file extension to the bundle name and searches it in the bundles directory. A bundle file is a json or a yaml file with the following structure:
|
When importing a bundle by name, the client appends ``.bundle`` file extension to the bundle name and searches it in the bundles directory. A bundle file is a JSON or a YAML file with the following structure:
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block:: json
|
||||||
|
|
||||||
|
@ -87,7 +87,7 @@ that failed would have red color.
|
|||||||
**while scanning a simple key in "<string>", line 32, column 3: ...**
|
**while scanning a simple key in "<string>", line 32, column 3: ...**
|
||||||
|
|
||||||
There is an error in YAML file format.
|
There is an error in YAML file format.
|
||||||
Before uploading a package, validate your file in an online yaml validator
|
Before uploading a package, validate your file in an online YAML validator
|
||||||
like `YAMLint <http://www.yamllint.com/>`_.
|
like `YAMLint <http://www.yamllint.com/>`_.
|
||||||
Later `validation tool <https://blueprints.launchpad.net/murano/+spec/murano-package-verification-tool>`_
|
Later `validation tool <https://blueprints.launchpad.net/murano/+spec/murano-package-verification-tool>`_
|
||||||
to check package closely while uploading will be added.
|
to check package closely while uploading will be added.
|
||||||
|
@ -131,7 +131,7 @@ Upload a new package[POST]
|
|||||||
|
|
||||||
`/v1/catalog/packages`
|
`/v1/catalog/packages`
|
||||||
|
|
||||||
See the example of multipart/form-data request, It should contain two parts - text (json string) and file object
|
See the example of multipart/form-data request, It should contain two parts - text (JSON string) and file object
|
||||||
|
|
||||||
**Request (multipart/form-data)**
|
**Request (multipart/form-data)**
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user