From ced6309bb3bc57ed2c927f46304d15db262f03be Mon Sep 17 00:00:00 2001
From: Giuseppe Attardi <giuseppe.attardi@garr.it>
Date: Sun, 21 Jul 2019 21:41:31 +0200
Subject: [PATCH] Update README.rst
---
costs-plugin/README.rst | 31 +++++++++++++++----------------
1 file changed, 15 insertions(+), 16 deletions(-)
diff --git a/costs-plugin/README.rst b/costs-plugin/README.rst
index e4d07d2..0f4b795 100644
--- a/costs-plugin/README.rst
+++ b/costs-plugin/README.rst
@@ -1,22 +1,21 @@
-Project costs estimation plugin for Consortium GARR
-===================================================
+Horizon plugin for displaying resource usage costs
+==================================================
Features
--------------------------
-
-**List project metrics and coresponding costs**
-``/project/costs``
-Displays a table with the following columns:
+--------
+
+This plugin adds a panel 'Costs' to the dashboard to visualize the costs of
+resource usage in a project.
+Costs are calculated from metrics obtained from Gnocchi and unit resource prices
+from the cloud usage database.
+
+The panel displays a table with the following columns:
- Metric Name
- Metric Description
- Resource Name
- Resource Type
- - Average Value
- - Unit
- - Price
- - Cost
-
-*Average Value* - Per hour consumption.
-*Price* - Coresponding price fetched from the separate price database.
-*Cost* - Final cost calculated based on the average value per hour and the coresponding price.
-
+ - Average Value. Resource consumption by the hours.
+ - Unit. Unit of resource metric
+ - Price. Unit price fetched from a separate price database.
+ - Cost. Final cost calculated based on the average value per hour and the
+ corresponding price
--
GitLab