Jump to: navigation, search

Difference between revisions of "Murano/Documentation/DynamicUI"

(Created page with "Dynamic UI Definition Manual The main purpose of Dynamic UI is to generate application creation forms "on-the-fly". Murano dashboard doesn't know anything about what applica...")
 
Line 1: Line 1:
Dynamic UI Definition Manual
+
=Dynamic UI Definition Manual=
  
 +
The main purpose of Dynamic UI is to generate application creation forms "on-the-fly". Murano dashboard doesn't know anything about what applications can be deployed and witch web form need to be used to create application instance. So all application definitions should contain yaml file which will tell dashboard now to create application and what validation  to be apply. This document will help you to compose valid UI definition to your application.
  
The main purpose of Dynamic UI is to generate application creation forms "on-the-fly". Murano dashboard doesn't know anything about what applications can be deployed and witch web form need to be used to create application instance. So all application definitions should contain yaml file which will tell dashboard how which form to use and what validation need to be applyed.
+
== Structure ==
 +
UI definition should be a valid yaml file and should contain the following sections (for version 2):
 +
* Version - points out to which syntax version is used
 +
* Templates - auxiliary section, using togeher with Apllication
 +
* Application - object model description which will be used in application deployment
 +
* Forms - web forms defenitions
 +
 
 +
==== Version ====
 +
Version of supported dynamic UI syntax
 +
 
 +
==== Application and Templates ====
 +
In Application section object model is described. According to this model application will be deployed. Here you can set where parameters you got from user will be used. To do this part of YAQL is used: way of setting valuabals ($ as the first symbol,
 +
 
 +
===supported types===
 +
'string': fields.CharField,
 +
    'boolean': fields.BooleanField,
 +
    'clusterip': fields.ClusterIPField,
 +
    'domain': fields.DomainChoiceField,
 +
    'password': fields.PasswordField,
 +
    'integer': fields.IntegerField,
 +
    'databaselist': fields.DatabaseListField,
 +
    'table': fields.TableField,
 +
    'flavor': fields.FlavorChoiceField,
 +
    'keypair': fields.KeyPairChoiceField,
 +
    'image': fields.ImageChoiceField,
 +
    'azone': fields.AZoneChoiceField,
 +
    'text': (fields.CharField, forms.Textarea),
 +
    'floatingip': fields.FloatingIpBooleanField,
 +
    'psqlDatabase'

Revision as of 13:47, 10 April 2014

Dynamic UI Definition Manual

The main purpose of Dynamic UI is to generate application creation forms "on-the-fly". Murano dashboard doesn't know anything about what applications can be deployed and witch web form need to be used to create application instance. So all application definitions should contain yaml file which will tell dashboard now to create application and what validation to be apply. This document will help you to compose valid UI definition to your application.

Structure

UI definition should be a valid yaml file and should contain the following sections (for version 2):

  • Version - points out to which syntax version is used
  • Templates - auxiliary section, using togeher with Apllication
  • Application - object model description which will be used in application deployment
  • Forms - web forms defenitions

Version

Version of supported dynamic UI syntax

Application and Templates

In Application section object model is described. According to this model application will be deployed. Here you can set where parameters you got from user will be used. To do this part of YAQL is used: way of setting valuabals ($ as the first symbol,

supported types

'string': fields.CharField,

   'boolean': fields.BooleanField,
   'clusterip': fields.ClusterIPField,
   'domain': fields.DomainChoiceField,
   'password': fields.PasswordField,
   'integer': fields.IntegerField,
   'databaselist': fields.DatabaseListField,
   'table': fields.TableField,
   'flavor': fields.FlavorChoiceField,
   'keypair': fields.KeyPairChoiceField,
   'image': fields.ImageChoiceField,
   'azone': fields.AZoneChoiceField,
   'text': (fields.CharField, forms.Textarea),
   'floatingip': fields.FloatingIpBooleanField,
   'psqlDatabase'