Skip to content

Commit

Permalink
Merge pull request #529 from Boavizta/528-docfaq-explicit-the-positio…
Browse files Browse the repository at this point in the history
…ning-of-cloud-scanner-compared-to-api-and-datavizta

doc(faq): differences between datavizta and cloud scanner and support…
demeringo authored Jun 14, 2024
2 parents b569ac8 + 9b65b40 commit 7f27a7c
Showing 3 changed files with 27 additions and 6 deletions.
9 changes: 5 additions & 4 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -2,9 +2,9 @@

# Tutorials 🚀

- [Quickstart - using CLI docker 🐳](tutorials/quickstart-docker.md)
- [Quickstart - dashboard using docker 🐳](tutorials/quickstart-dashboard-docker.md)
- [Quickstart - using cargo 🦀](tutorials/quickstart-rust-cli.md)
- [Quickstart - CLI (docker 🐳)](tutorials/quickstart-docker.md)
- [Quickstart - Dashboard (docker 🐳)](tutorials/quickstart-dashboard-docker.md)
- [Quickstart - CLI (cargo 🦀)](tutorials/quickstart-rust-cli.md)
- [Quickstart as serverless ⚡](tutorials/quickstart-serverless.md)

# Explanations
@@ -26,7 +26,8 @@

# Reference

- [💡 Common issues and FAQ](reference/common-issues-and-FAQ.md)
- [FAQ 💡](reference/FAQ.md)
- [Common issues 🧰](reference/common-issues.md)
- [CLI options](reference/cli-options.md)
- [Environment variables](reference/env-vars.md)
- [OpenAPI specification in server mode](reference/openapi-server-mode.md)
20 changes: 20 additions & 0 deletions docs/src/reference/FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Frequently Asked Questions

## What are differences between Datavizta and Cloud scanner ?

Both tools rely on the same source of impact data (i.e. the [BoaviztAPI](https://api.boavizta.org/). The API is used to estimation the impacts of aws instances.

- [Datavizta](https://dataviz.boavizta.org/cloudimpact) is positioned as a _pedagogical_ front end to the API. It helps users understand which kind of data the API, quickly test hypothesis. It offers visualizations of impacts of multiple indicators for different lifecycle steps (use vs manufacture).

- Cloud scanner is more **production oriented**. It returns same data as Datavizta but _in different form and with different inputs_.
The main objective of cloud scanner is to help quickly retrieve the impacts of an entire AWS account by **automating the inventory** of resource used and the retrieval of associated impacts.

In addition cloud scanner **can be used as a monitoring system** that runs regularly. In this later case, it generates **results as metrics** (in standard _Prometheus / Open metrics_ format). Theses metrics can be consumed by external systems, to ease further analysis (e.g. breakdown by service / tags or countries) or use custom visualizations (like an external dashboard).

## Which cloud provider or service is supported ?

AWS (instances and block storage).

- Only AWS is supported for the time being. The reason is that historically BoaviztAPI could only provide reference data for AWS instances.
- Azure instances are on the roadmap. After data becomes available in Boavizta API, cloud scanner will be adapted to support Azure https://github.com/Boavizta/cloud-scanner/issues/15.
- In addition BoaviztAPI is working on providing impacts of Storage as a service. It will be integrated to cloud scanner once available. https://github.com/Boavizta/boaviztapi/issues/143
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Common issues and FAQ
# Common issues

## The demo dashboard does not show any metric...

@@ -11,7 +11,7 @@ Several reasons may explain why metrics do not appear in the dashboard.
- eu-west-1
- eu-west-3
- eu-central-1
- us-east-1
- us-east-1

Refer to [Generating metrics for additional regions](../how-to/set-up-dashboard.md#generating-metrics-for-additional-regions) to retrieve metrics for additional regions.

0 comments on commit 7f27a7c

Please sign in to comment.