Merge pull request #387 from Boavizta/386-use-api-v110

feat: use API v1.1.0 in docker-compose

CHANGELOG.md

@@ -13,6 +13,11 @@ _This paragraph may describe WIP/unreleased features_
 
 ### Changed
 
+- Use API v1.1.0 in docker-compose (support aditional instances): https://github.com/Boavizta/cloud-scanner/issues/386
+- Update logo in documentation https://github.com/Boavizta/cloud-scanner/pull/381
+- Add link checker when pubishing doc https://github.com/Boavizta/cloud-scanner/pull/382
+- Add logo in the doc website https://github.com/Boavizta/cloud-scanner/pull/383
+
 ## [1.0.1]-2023-10-27
 
 ### Added

docker-compose.yml

@@ -54,7 +54,7 @@ services:
   boavizta_api:
     container_name: "boavizta_api"
     hostname: boavizta
-    image:  ghcr.io/boavizta/boaviztapi:1.0.0
+    image:  ghcr.io/boavizta/boaviztapi:1.1.0
     ports:
       - "5000:5000"
     networks:

docs/src/explanations/methodology.md

@@ -2,9 +2,15 @@
 
 Cloud scanner uses the Boavizta methodology to estimate the impacts of cloud resources.
 
-The methodology of Boavizta is described in [Digital & environment : How to evaluate server manufacturing footprint, beyond greenhouse gas emissions? | Boavizta](https://boavizta.org/en/blog/empreinte-de-la-fabrication-d-un-serveur)
+## Source of impact data
 
-Impact data is retrieved from [BOAVIZTA reference data API](https://github.com/Boavizta/boaviztapi/) v1.0.x.
+Impact data is retrieved from [BOAVIZTA reference data API](https://github.com/Boavizta/boaviztapi/) v1.1.x.
+
+## Methodology
+
+The general approach of Boavizta is described in [Digital & environment : How to evaluate server manufacturing footprint, beyond greenhouse gas emissions? | Boavizta](https://boavizta.org/en/blog/empreinte-de-la-fabrication-d-un-serveur)
+
+The impacts (use and embedded) are attributed according to the principles described in [Cloud instances - Boavizta API documentation](https://doc.api.boavizta.org/Explanations/devices/cloud/).
 
 The results are similar to what you can visualize in [Datavizta](http://datavizta.boavizta.org/cloudimpact), but with automated inventory.
 
@@ -13,4 +19,3 @@ The results are similar to what you can visualize in [Datavizta](http://datavizt
 See also [other limits](../reference/limits.md).
 
 - https://www.boavizta.org/en
-- https://boavizta.org/en/blog/empreinte-de-la-fabrication-d-un-serveur

docs/src/reference/limits.md

@@ -9,20 +9,19 @@ The Boavizta impact data result from a modelling effort. It is important to cons
 
 ## Perimeter / scope
 
-Cloud scanner _only_ estimates the impacts of your AWS EC2  instances.
+Cloud scanner _only_ estimates the impacts of your AWS EC2  instances, and optionally block storage.
 
 Several significant aspects of the global impacts of cloud usage are **excluded**:
 
 - only estimate impacts of _compute_ instances (EC2 Virtual Machines).
 - do not account for the surrounding cloud infrastructure (network, control plan).
-- for **storage** (experimental feature), **only** the impacts of **manufacture** are counted. The impacts of the _use_ phase are _not_ counted. Boavizta API returns only the impacts of the _manufacturing_ phase for HDD and SSD. Furthermore the impacts of storage are likely _are likely overestimated_. They are calculated by taking into account the size of the logical volume. In reality, a volume that is not full may not claim the full space on a physical device, which would result in smaller impacts.
+- for **storage** (experimental feature), **only** the impacts of **manufacture** are counted. The impacts of the _use_ phase are _not_ counted. Boavizta API returns only the impacts of the _manufacturing_ phase for HDD and SSD. Furthermore the impacts of storage _are likely overestimated_. They are calculated by taking into account the size of the logical volume. In reality, a volume that is not full may not claim the full space on a physical device, which would result in smaller impacts.
 - do not take into account the _over-commit_ (mutualization) or _over-provisioning_(redundancy) that cloud provider may apply to provide the service.
 - do not account managed services (like DB as a service or Containers as a service).
 - do not account serverless (lambda) compute.
 - supported regions (EU and US only for the time being).
 - unsupported instance types returns zero for their impacts.
 - we do not provide (yet) error margins <https://github.com/Boavizta/boaviztapi/issues/147>.
-- the manufacturing impacts are not amortized (i.e. values returned for manufacturing impacts do not consider usage duration).
 
 ## Other limits
 
@@ -36,19 +35,16 @@ This is particularly relevant when considering CoEq indicator because the carbon
 
 ### Instances supported
 
-Cloud scanner supports all instances types of Boavizta API. But when a specific instance type cannot be matched with the Boavizta data set,
-Cloud-scanner returns empty impacts (i.e. zeroed impact values).
-
-See also [Issues · Boavizta/cloud-scanner](https://github.com/Boavizta/cloud-scanner/issues).
+Cloud scanner supports all instances types of Boavizta API. But when a specific instance type cannot be matched with the Boavizta data set, Cloud-scanner returns empty impacts (i.e. zeroed impact values).
 
 ### Carbon intensity is not real time
 
 Carbon intensity of electricity is not (yet) real time. It uses and yearly extract. This is more related to the API itself, see <https://github.com/Boavizta/boaviztapi/issues/117> and general Boavizta API methodology.
 
-### Allocation of manufacture impacts
-
-Today, cloud scanner returns the manufacture impacts of a resource corresponding to _the entire lifecycle_ of the ressource. The manufacture impacts returned for a VM are the same if you use it one hours or several year. To say it differently, we do _not_ amortize the manufacturing impacts over the duration of use.
-
 ### We do not provide margins of error
 
 Cloud scanner is not yet able to provide error margin related to it's estimation. Note that there is ongoing work on Boavizta API to provide more details about the error margins: <https://github.com/Boavizta/boaviztapi/issues/147>
+
+### Open issues / bugs
+
+See also [Issues · Boavizta/cloud-scanner](https://github.com/Boavizta/cloud-scanner/issues).