From 3fdcb277186bb78b7b87756303200d156e2bd064 Mon Sep 17 00:00:00 2001 From: sguazt <marco.guazzone@gmail.com> Date: Fri, 25 Dec 2020 15:01:53 +0100 Subject: [PATCH] Improved doc --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0a79092..6d30254 100755 --- a/README.md +++ b/README.md @@ -10,13 +10,15 @@ EasyCloud is a toolkit written in Python able to interact with multiple cloud platforms, such as OpenStack, Amazon Web Services (AWS) and Google Cloud Platform (GCP). <!-- It is based on the [CloudTUI-FTS](https://github.com/mrbuzz/CloudTUI-FTS) project. --> -With EasyCloud, a user can: +With EasyCloud, a user can: + * start/stop/clone a VM * manage floating IPs and volumes * monitor the VMs health status -* gather metrics data from instances and send them into multiple sinks (e.g., save them in plain CSV files or in a Redis data store, or publish them to Apache Kafka) +* gather metrics data from instances and send them into multiple sinks (e.g., save them in plain CSV files or in a [Redis](https://www.redis.io) data store, or publish them to [Apache Kafka](https://kafka.apache.org), or even to push them on third-party monitoring systems like [Prometheus](https://www.prometheus.io)) * create/manage policies in order to prevent faults (i.e., "if the CPU utilization is higher than XX %, then clone it") + ## Quick start: 1. **Requirements** @@ -133,6 +135,22 @@ The following platforms are currently supported by EasyCloud * **[Google Cloud Platform](https://cloud.google.com)** * **[Openstack](https://www.openstack.org)** +## Supported measure sinks + +_Measure sinks_ are subsystems to which you can send metrics data gathered from your instances. +Currently, EasyCloud supports the following measure sinks: + +* [Apache ActiveMQ](https://activemq.apache.org) +* [Apache Cassandra](https://cassandra.apache.org) +* [Apache Kafka](https://kafka.apache.org) +* CSV files +* [MongoDB](https://www.mongodb.com) +* [Promethues](https://www.prometheus.io) +* [RabbitMQ](https://www.rabbitmq.com) +* [Redis](https://www.redis.io) + +There is also a _dummy_ sink that is useful for debugging and testing purpose. + ## Source code download You can download the application source code from our git repository by using the `git clone git@gitlab.di.unipmn.it:DCS/easycloud.git` command. -- GitLab