-
Notifications
You must be signed in to change notification settings - Fork 10
Simplify readme #583
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Simplify readme #583
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,67 +8,13 @@ | |
|
|
||
| --- | ||
|
|
||
|
|
||
| ```mermaid | ||
| graph LR; | ||
| inventory[ Account inventory] | ||
| api[Impacts from BoaviztaAPI] | ||
| metrics[Prometheus metrics] | ||
| json[JSON output] | ||
| inventory --> api | ||
| api --> metrics | ||
| api --> json | ||
| ``` | ||
|
|
||
| Cloud scanner combines real time _inventory_ and _usage_ data from your AWS account with [Boavizta API](https://github.com/Boavizta/boaviztapi/) to offer a view of your impacts on a given region. | ||
|
|
||
| - multi criteria: Primary Energy consumption (PE), Abiotic resource depletion potential (ADP), and Global Warming Potential (GWP) | ||
| - multi stage: separate impacts of resources Usage and Manufacture | ||
|
|
||
| This is similar to what you can get from [Datavizta](http://datavizta.boavizta.org/cloudimpact) but with automated inventory. | ||
|
|
||
| Estimations can be filtered by tags. It eases attribution to a specific server, environment, application or service. | ||
|
|
||
| Cloud-scanner can be used: | ||
|
|
||
| - from command line, to get an immediate view of your impacts 💻 | ||
| - as a metric server . You can use it to monitor and display real time impacts in a dashboard 📊 | ||
|
|
||
|  | ||
|
|
||
| How it works: | ||
|
|
||
| Cloud scanner follows Boavizta approach. | ||
|
|
||
| > Thibault Simon, David Ekchajzer, Adrien Berthelot, Eric Fourboul, Samuel Rince, et al.. BoaviztAPI: a bottom-up model to assess the environmental impacts of cloud services. HotCarbon'24. Workshop on Sustainable Computer Systems, Jul 2024, Santa Cruz, United States. [⟨hal-04621947v1⟩](https://hal.science/hal-04621947v1) | ||
|
Comment on lines
-41
to
-43
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. And keep theses lines too: Cloud scanner follows Boavizta approach.
|
||
|
|
||
|  | ||
|
|
||
| ## Usage and documentation | ||
|
|
||
| The complete documentation: [Introduction - Boavizta cloud scanner 📡](https://boavizta.github.io/cloud-scanner/). | ||
|
|
||
| ## Getting started 🚀 | ||
|
|
||
| - [Quickstart - dashboard using docker 🐳 - Boavizta cloud scanner 📡](https://boavizta.github.io/cloud-scanner/tutorials/quickstart-dashboard-docker.html) | ||
| - [Quickstart - using CLI docker 🐳 - Boavizta cloud scanner 📡](https://boavizta.github.io/cloud-scanner/tutorials/quickstart-docker.html) | ||
|
|
||
| ## Deployment as a serverless app (aws lambda) ⚡ | ||
|
|
||
| Cloud scanner can also be deployed as a serverless application for aws. | ||
|
|
||
| - [Quickstart as serverless ⚡ - Boavizta cloud scanner 📡](https://boavizta.github.io/cloud-scanner/tutorials/quickstart-serverless.html) | ||
| - [Serverless design - Boavizta cloud scanner 📡](https://boavizta.github.io/cloud-scanner/reference/serverless-design.html) | ||
| - [Quickstart - dashboard using docker 🐳](https://boavizta.github.io/cloud-scanner/tutorials/quickstart-dashboard-docker.html) | ||
| - [Quickstart - using CLI docker 🐳](https://boavizta.github.io/cloud-scanner/tutorials/quickstart-docker.html) | ||
| - [Quickstart - using serverless ⚡](https://boavizta.github.io/cloud-scanner/tutorials/quickstart-serverless.html) | ||
| - [Quickstart - using CLI Rust 🦀](https://boavizta.github.io/cloud-scanner/tutorials/quickstart-rust-cli.html) | ||
|
|
||
| ## Output formats | ||
|
|
||
| Cloud scanner returns data as _json_ or _Open Metrics_ (Prometheus) format. | ||
|
|
||
| See [Output data - Boavizta cloud scanner 📡](https://boavizta.github.io/cloud-scanner/reference/output-data.html) | ||
|
|
||
| ## ⚠ Perimeter / scope and limits | ||
|
|
||
| Cloud scanner _only_ estimates the impacts of your AWS EC2 instances and optionally block storage. | ||
|
|
||
| The limitations of cloud-scanner are documented in [Limitations - Boavizta cloud scanner 📡](https://boavizta.github.io/cloud-scanner/reference/limits.html) | ||
| ## Usage and documentation 📚 | ||
|
|
||
| The complete documentation: [Introduction - Boavizta cloud scanner 📡](https://boavizta.github.io/cloud-scanner/). | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would like to keep theses lines:
Cloud scanner combines real time inventory and usage data from your AWS account with Boavizta API to offer a view of your impacts on a given region.
This is similar to what you can get from Datavizta but with automated inventory.