openstack/deb-murano
Code Issues Proposed changes

[Murano docs] Examples section review

Browse Source 
1. Improves the table appearance.
2. Fixes several mistakes

Change-Id: I57f8a6aa7e9dca3f76ef0eb234d86918ff0aeee6
This commit is contained in:
OlgaGusarenko 2015-05-29 18:47:40 +03:00
parent 46362edb04
commit d24f4a5786
1 changed files with 59 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
doc/source/draft/appdev-guide/examples.rst
View File

@ -7,49 +7,63 @@
Examples Examples
======== ========
.. _Zabbix Agent: https://github.com/openstack/murano-apps/tree/master/ZabbixAgent/package .. list-table::
.. _Zabbix Server: https://github.com/openstack/murano-apps/tree/master/ZabbixServer/package :header-rows: 1
.. _Docker Crate: https://github.com/openstack/murano-apps/tree/master/Docker/Applications/Crate/package :widths: 30 70
:stub-columns: 0
:class: borderless
+-------------------+----------------------------------------------------------------------------+ * - Application name
| Application Name | Description | - Description
+===================+============================================================================+
|| || Zabbix Agent is a simple application. It doesn’t deploy a VM by itself, | * - | `Zabbix Agent`_
|| || but is installed on a specific VM that may contain any other | - Zabbix Agent is a simple application. It doesn’t deploy a VM by itself,
|| || applications. This VM is tracked by Zabbix and by its configuration. | but is installed on a specific VM that may contain any other
|| || | applications. This VM is tracked by Zabbix and by its configuration.
|| || So Murano performs the Zabbix agent configuration based on the user |
|| `Zabbix Agent`_ || input. User chooses the way of instance tracking - HTTP or ICMP that may | So Murano performs the Zabbix agent configuration based on the user
|| || perform some modifications in the application package. | input. The user chooses the way of instance tracking - HTTP or ICMP that may
|| || | perform some modifications in the application package.
|| || It is worth noting that application scripts are written in Python, not |
|| || in Bash as usual. This application does not work without Zabbix server | It is worth noting that application scripts are written in Python, not
|| || application since it's a required property, determined in the | in Bash as usual. This application does not work without Zabbix server
|| || application definition. | application since it’s a required property, determined in the
+-------------------+----------------------------------------------------------------------------+ application definition.
|| || Zabbix Server application interacts with Zabbix Agent by calling its |
|| || setUpAgent method and providing information about itself: IP and hostname | * - | `Zabbix Server`_
|| `Zabbix Server`_ || of VM on which the server is installed. Server installs MySQL database and| - Zabbix Server application interacts with Zabbix Agent by calling its
|| || requests database name, password and some other parameters from the user. | setUpAgent method and providing information about itself: IP and hostname
+-------------------+----------------------------------------------------------------------------+ of VM on which the server is installed.
|| || This is a good example on how a difficult logic may be simplified with |
|| || the inheritance that is supported by MuranoPL. Definition of this app is | Server installs MySQL database and requests database name, password and
|| || simple, but the opportunity it provides is fantastic. | some other parameters from the user.
|| || |
|| || Crate is a distributed database, in Murano Application catalog it | * - | `Docker Crate`_
|| || looks like a regular application. It may be deployed on Google Kubernetes | - This is a good example on how difficult logic may be simplified with
|| || or regular Docker server. User picks the desired option while filling in | the inheritance that is supported by MuranoPL. Definition of this app is
|| || the form since these options are set in the UI definition. The form field | simple, but the opportunity it provides is fantastic.
|| || has a list of possible options: |
|| `Docker Crate`_ || ... | Crate is a distributed database, in the Murano Application catalog it
|| || type: | looks like a regular application. It may be deployed on Google Kubernetes
|| || - io.murano.apps.docker.kubernetes.KubernetesPod | or regular Docker server. The user picks the desired option while filling in
|| || - io.murano.apps.docker.DockerStandaloneHost | the form since these options are set in the UI definition. The form field
|| || | has a list of possible options::
|| || Information about the application itself (docker image and port that is |
|| || needed to be opened) is contained in the getContainer method. All other | ...
|| || actions for the application configuration are located at the | type:
|| || DockerStandaloneHost definition and its dependencies. Note that this | - io.murano.apps.docker.kubernetes.KubernetesPod
|| || application doesn't have a filename:Resources folder at all since the | - io.murano.apps.docker.DockerStandaloneHost
|| || installation is made by Docker itself. |
+-------------------+----------------------------------------------------------------------------+ Information about the application itself (docker image and port that is
needed to be opened) is contained in the getContainer method. All other
actions for the application configuration are located at the
DockerStandaloneHost definition and its dependencies. Note that this
application doesn’t have a filename:Resources folder at all since the
installation is made by Docker itself.
.. Links:
.. _`Zabbix Agent`: https://github.com/openstack/murano-apps/tree/master/ZabbixAgent/package
.. _`Zabbix Server`: https://github.com/openstack/murano-apps/tree/master/ZabbixServer/package
.. _`Docker Crate`: https://github.com/openstack/murano-apps/tree/master/Docker/Applications/Crate/package