https://github.com/fiware/ops.fidash
This is a mirror repo. Please fork from https://github.com/fidash/fiware-fidash
https://github.com/fiware/ops.fidash
Last synced: 17 days ago
JSON representation
This is a mirror repo. Please fork from https://github.com/fidash/fiware-fidash
- Host: GitHub
- URL: https://github.com/fiware/ops.fidash
- Owner: FIWARE
- License: apache-2.0
- Created: 2016-02-02T14:38:44.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-10-04T09:59:54.000Z (over 9 years ago)
- Last Synced: 2025-01-18T08:29:33.884Z (12 months ago)
- Language: HTML
- Size: 2.33 MB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FIDASH: FIWARE's Cloud Dashboard
FIDASH is an administration and management dashboard for FIWARE Lab. FIDASH is the dashboard component of the FIWARE FI-OPS tools, a tool suite created to monitor and administer FIWARE Lab nodes based on FIWARE Lab features such as: the underlying federated [OpenStack](https://www.openstack.org/)-based nodes; the monitoring infrastructure; other administrative and operational tools created by FITOOLKIT and FIHEALTH enablers.
This project is part of [FIWARE](https://www.fiware.org/) [1].
## Description
FIDASH is a tailored version of [WireCloud](http://conwet.fi.upm.es/wirecloud/) [2] and has such is a highly-customizable [mashup](https://en.wikipedia.org/wiki/Mashup_%28web_application_hybrid%29) [3] environment that allows the user to easily define functionality and behaviour of the dashboard. The dashboard is made up of multiple widgets that the user can choose, discard, set layout and modify their behaviour.
These widgets offer specific functionality such as display a list of instances or synchronize the flavors of some FIWARE Lab. Widgets rely on REST-based APIs offered by the different OpenStack services, the SLA Manager, XIFI Monitoring or other services created in FITOOLKIT or FIHEALTH projects to give support for certain actions. Some services are directly accessed, though others use some libraries to hide the complexity of the APIs, such as the [jstack]( https://github.com/ging/jstack) [4] library for accessing OpenStack services in FIWARE Lab deployments. Authentication is managed by the underlying WireCloud platform against the Identity Management (IdM) and the keystone Proxy present on all FIWARE Lab nodes, and authorization relies on the user rights present at the IdM.
These widget are connected together to perform higher level functions and to provide correct feedback based on actions done by other components; such integration is done through a mechanism called _wiring_, that send asynchronous messages with data among themselves (events). User of FIDASH is in control of that wiring, and can connect/disconnect widgets at will, modifying the behaviour of the dashboard.
In addition, FIDASH comes with predefined dashboard set-ups (mashups with instantiated widgets and set up wiring) for an out-of-the-box usage; nonetheless the user can modify existing dashboard set-ups or create new ones from scratch, in a guided and intuitive manner. Both functionality and appearance can be customized by the user.
## Features implemented
FIDASH, as FI-OPS dashboard, is the graphical front-end that offers FIWARE Lab admins with a comprehensive access to different back-end services, namely:
* Monitor the usage of resources in live usage of resources at different levels:
* Regions: display the free and used vCPUs, RAM, storage space, and IP addresses assigned and reserved
* Hosts per region: display the percentage of CPU, RAM and storage used
* VMs per region: display the percentage of CPU, RAM and storage used
* Maintenance Calendar, where maintenance periods can be defined per region so as interested people can be informed, as well as a mechanism to request for _no maintenance periods_ during certain periods where events are to be held
* Display the top tenants in terms of resource usage, showing and sorting by number of VMs, amount of RAM, number of virtual CPUs, percentage of RAM or CPU used
* Display the status of the generic enablers Global Instances
* Display the OpenStack component versions installed on the different nodes
* Synchronization of flavors across different regions
* Synchronization of images across different regions
* OpenStack services for managing offered resources in FIWARE Cloud. The elements managed at FIDASH are:
* running instances or VMs, they can be listed, detailed, searched, filtered, deleted and rebooted. Simple creation functionality is also provided
* images, that can be listed, detailed, searched, filtered, made public or protected, and created from file or remote URL. Simple launch functionality is also provided
* volumes, that can be listed, detailed, searched, filtered, and attached to volumes
* flavors, that can be listed, detailed, searched and filtered. Edition and creation of new ones is also implemented but requires administrative privileges.
* verification of the compliance with established Service Level Agreements.
The default widgets in FIDASH are:
* Detail Image:
* Detail Instance:
* Detail Volume:
* List Flavors:
* List Images:
* List Instances:
* List Volumes:
* Embedded SLA Manager:
* SLA Manager:
* Select Regions:
* Monitor Regions:
* Monitor VMs:
* Monitor Hosts:
* Historical Monitor Regions:
* Historical Monitor VMs:
* Historical Monitor Hosts:
* Maintenance Calendar:
* Show Difference Flavors:
* Compare Flavors:
* Manage Promoted Flavors:
* Synchronize Images:
* Top tenants (data-usage):
* Generic Enablers global instances:
* OpenStack installed versions:
## Installation manual
To see how to deploy FIDASH, please refer to the [Deploy Guide](docs/deploy/deploy.md).
## Installation verification
A correct installation of FIDASH must have all the FIDASH widgets, as described below, available in the section "My resources".
The permissions have to be tested by service:
* To check OpenStack-based services deploy ListImages widget on any dashboard. It should list the public images.
* To check Monitoring services deploy Resource Usage widget and display information about different regions, in case some of them has these services not available. Graphs showing the RAM, CPU, IP addresses and storage used should appear.
* To check SLA Management deploy Embedded SLA Manager. The web interface of the manager should appear inside the widget
## User manual
The instructions for FIDASH users, including the creating dashboards, customize existing ones and modify their behaviour is described in the [User Guide](docs/user_guide/user_guide.md)
## Developer guide
The instructions for developing new widgets or modifying existing are described in the [Developer Guide](docs/developer/developer_guide.md)
## Know issues
Widgets can work without major problems with HTTP connection, but please be aware that this can create a security problem. For HTTPS connection could be needed that the server sends some HTTP Headers to enable the
visualization of the data or to relax some policies (e.g. [Same-origin policy](https://en.wikipedia.org/wiki/Same-origin_policy) ).
In modern browsers, linking to an HTTP resource from an HTTPS page is forbidden and a slight notice might be shown by the browser (Firefox and chrome show a shield icon next to the address bar) to allow these kind of connections. During the development of FIDASH and the associated back-end services, some HTTP services might be used, and user should allow these types of connections manually (by clicking on that shield in the case of Firefox and chrome).
FIDASH widgets are developed and tested on Chrome and Chromium browsers. Firefox does not render correctly the Resources Usage widget. However WireCloud platform, on which FIDASH is based, is tested on Firefox and chrome browsers though other browsers supporting HTML5 standards will probably be 100% compatible, but it is not guaranteed.
## License
Apache License, Version 2.0, January 2004
## References
1. FIWARE: [https://www.fiware.org/](https://www.fiware.org/)
2. WireCloud: [http://conwet.fi.upm.es/wirecloud/](http://conwet.fi.upm.es/wirecloud/)
3. Mashup definition at Wikipedia: [https://en.wikipedia.org/wiki/Mashup_%28web_application_hybrid%29](https://en.wikipedia.org/wiki/Mashup_%28web_application_hybrid%29)
4. JStack library: [https://github.com/ging/jstack](https://github.com/ging/jstack)