flavien peyre 81f8950e07 Documentation of webui
Change-Id: I7dae5e5caca4461e4cc9a8d72b521198bf460f8b
2015-08-25 15:05:52 -04:00

112 lines
2.3 KiB
ReStructuredText

.. _webui_directives_containers:
Components of a container
~~~~~~~~~~~~~~~~~~~~~~~~~
info
****
Show all information pf a Surveil objects
.. code-block:: javascript
{
"type": "info",
"attributes": {
"inputSource": {
"MyTileTitle": "myInputSource"
}
}
MyTileTitle (required)
Tile of the tile
myInputSource
key of the var fillParams inside container.js file .This key select the type of object in the tile
host main
*********
Show inside a tile the address and the alias of a host
.. code-block:: javascript
{
"type": "host-main",
"attributes": {}
}
host live
*********
Show inside a tile the host state, its output and it's state icon
.. code-block:: javascript
{
"type": "host-live",
"attributes": {}
}
host load
*********
Show inside a tile the load metrics state, its output and it's state icon for an host
.. code-block:: javascript
{
"type": "host-load",
"attributes": {}
}
host cpu
********
Show inside a tile the cpu metrics state, its output and it's state icon for an host
.. code-block:: javascript
{
"type": "host-cpu",
"attributes": {}
}
host service list
*****************
Show inside a tile the service description, its acknowledge and its status for all service hosts
.. code-block:: javascript
{
"type": "host-services-list",
"attributes": {}
}
service main
************
Show inside a tile the host attached to a service
.. code-block:: javascript
{
"type": "service-main",
"attributes": {}
}
service live
************
Show inside a tile the service state, its output and it's state icon
.. code-block:: javascript
{
"type": "service-live",
"attributes": {}
}
service info
************
Show inside a tile the service description, its acknowledge and its status
.. code-block:: javascript
{
"type": "service-info",
"attributes": {}
}
service graphs
**************
Show a grafana graph for each service metric
.. code-block:: javascript
{
"type": "service-graphs",
"attributes": {}
}