Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/explanations/methodology.html b/explanations/methodology.html
new file mode 100644
index 00000000..15c609a1
--- /dev/null
+++ b/explanations/methodology.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Estimating impacts of block storage
+Block storage volumes are approximated either as SSD or HDD depending on cloud provider specific storage type.
+This is a basic estimation. It takes into account the size of the block storage volume.
+⚠ Only the manufacture impacts of the Block storage are returned. The impacts of the use phase are returned as zero (mainly because we lack the related data in current version of Boavizta API).
+Block storage (EBS) estimation (AWS)
+What is considered in estimation:
+-
+
- storage type (HDD vs SSD) +
- storage size +
- duration of use +
| AWS EBS volume type | Boavizta storage used for estimation | comments |
|---|---|---|
| st1 | HDD | |
| sc1 | HDD | |
| magnetic (standard) | HDD | |
| gp2 | SSD | |
| gp3 | SSD | |
| io1 | SSD | |
| io2 | SSD | |
| unknown type | SSD | If it cannot identify the type of storage (like when a new type is introduced, cloud scanner uses SSD as an approximation) |
What is not considered for the estimation
+-
+
- If the storage offers provisioned IOPS or not. +
- Implicit redundancy related to storage type. +
- Any other infrastructure (network, backup, supervision or redundancy) that may allow the cloud provider to offer EBS service. +
Block storage estimations (Azure)
+Not yet implemented.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/explanations/processing-workload.html b/explanations/processing-workload.html
new file mode 100644
index 00000000..22cadac3
--- /dev/null
+++ b/explanations/processing-workload.html
@@ -0,0 +1,227 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methodology and source of data
+Cloud scanner relies on the Boavizta methodology and data to estimate the impacts of cloud resources.
+It performs an inventory of the resources used in a cloud account. It then returns impacts of the use phase but also impacts related to the manufacture of the identified resources (embodied impacts).
+The source of impact data
+Impact data is retrieved from BOAVIZTA reference data API v1.2.x.
+General approach and limits
+Cloud scanner estimates impacts according to the duration of use of cloud resources. It also considers the “intensity” of use (like the type of instance and CPU load for a VM or size of a disk for storage). The region of use is also considered to take into account the electricity mix of the region (carbon intensity).
+++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⟩
+
The general approach is to map cloud vendor specific ressources, either to Boavizta cloud resources (like for VM instances) or to more generic components (Block storage volumes are approximated as Boavizta HDD or SSD).
+But this approach means that a large portion of the cloud provider infrastructure is excluded from the estimation.
+⚠ Cloud scanner underestimates the impacts of a cloud account. Because it only considers the instances and block storage, many additional sources of impacts (network, potential redundancy, cloud control plan, buildings…) are not included in the estimation.
+
See also other limits.
+Methodology
+The Boavizta methodology is described in Digital & environment : How to evaluate server manufacturing footprint, beyond greenhouse gas emissions? | Boavizta
+The impacts (use and embedded) are attributed according to the principles described in Cloud instances - Boavizta API documentation.
+The results of cloud scanner are similar to what you can visualize in Datavizta, but with automated inventory.
+-
+
- Boavizta website: https://www.boavizta.org/en +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/favicon.png b/favicon.png
new file mode 100644
index 00000000..a5b1aa16
Binary files /dev/null and b/favicon.png differ
diff --git a/favicon.svg b/favicon.svg
new file mode 100644
index 00000000..90e0ea58
--- /dev/null
+++ b/favicon.svg
@@ -0,0 +1,22 @@
+
+
diff --git a/fonts/OPEN-SANS-LICENSE.txt b/fonts/OPEN-SANS-LICENSE.txt
new file mode 100644
index 00000000..d6456956
--- /dev/null
+++ b/fonts/OPEN-SANS-LICENSE.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/fonts/SOURCE-CODE-PRO-LICENSE.txt b/fonts/SOURCE-CODE-PRO-LICENSE.txt
new file mode 100644
index 00000000..366206f5
--- /dev/null
+++ b/fonts/SOURCE-CODE-PRO-LICENSE.txt
@@ -0,0 +1,93 @@
+Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/fonts/fonts.css b/fonts/fonts.css
new file mode 100644
index 00000000..858efa59
--- /dev/null
+++ b/fonts/fonts.css
@@ -0,0 +1,100 @@
+/* Open Sans is licensed under the Apache License, Version 2.0. See http://www.apache.org/licenses/LICENSE-2.0 */
+/* Source Code Pro is under the Open Font License. See https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL */
+
+/* open-sans-300 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 300;
+ src: local('Open Sans Light'), local('OpenSans-Light'),
+ url('open-sans-v17-all-charsets-300.woff2') format('woff2');
+}
+
+/* open-sans-300italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 300;
+ src: local('Open Sans Light Italic'), local('OpenSans-LightItalic'),
+ url('open-sans-v17-all-charsets-300italic.woff2') format('woff2');
+}
+
+/* open-sans-regular - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 400;
+ src: local('Open Sans Regular'), local('OpenSans-Regular'),
+ url('open-sans-v17-all-charsets-regular.woff2') format('woff2');
+}
+
+/* open-sans-italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 400;
+ src: local('Open Sans Italic'), local('OpenSans-Italic'),
+ url('open-sans-v17-all-charsets-italic.woff2') format('woff2');
+}
+
+/* open-sans-600 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 600;
+ src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
+ url('open-sans-v17-all-charsets-600.woff2') format('woff2');
+}
+
+/* open-sans-600italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 600;
+ src: local('Open Sans SemiBold Italic'), local('OpenSans-SemiBoldItalic'),
+ url('open-sans-v17-all-charsets-600italic.woff2') format('woff2');
+}
+
+/* open-sans-700 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 700;
+ src: local('Open Sans Bold'), local('OpenSans-Bold'),
+ url('open-sans-v17-all-charsets-700.woff2') format('woff2');
+}
+
+/* open-sans-700italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 700;
+ src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'),
+ url('open-sans-v17-all-charsets-700italic.woff2') format('woff2');
+}
+
+/* open-sans-800 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 800;
+ src: local('Open Sans ExtraBold'), local('OpenSans-ExtraBold'),
+ url('open-sans-v17-all-charsets-800.woff2') format('woff2');
+}
+
+/* open-sans-800italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 800;
+ src: local('Open Sans ExtraBold Italic'), local('OpenSans-ExtraBoldItalic'),
+ url('open-sans-v17-all-charsets-800italic.woff2') format('woff2');
+}
+
+/* source-code-pro-500 - latin_vietnamese_latin-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Source Code Pro';
+ font-style: normal;
+ font-weight: 500;
+ src: url('source-code-pro-v11-all-charsets-500.woff2') format('woff2');
+}
diff --git a/fonts/open-sans-v17-all-charsets-300.woff2 b/fonts/open-sans-v17-all-charsets-300.woff2
new file mode 100644
index 00000000..9f51be37
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-300.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-300italic.woff2 b/fonts/open-sans-v17-all-charsets-300italic.woff2
new file mode 100644
index 00000000..2f545448
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-300italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-600.woff2 b/fonts/open-sans-v17-all-charsets-600.woff2
new file mode 100644
index 00000000..f503d558
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-600.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-600italic.woff2 b/fonts/open-sans-v17-all-charsets-600italic.woff2
new file mode 100644
index 00000000..c99aabe8
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-600italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-700.woff2 b/fonts/open-sans-v17-all-charsets-700.woff2
new file mode 100644
index 00000000..421a1ab2
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-700.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-700italic.woff2 b/fonts/open-sans-v17-all-charsets-700italic.woff2
new file mode 100644
index 00000000..12ce3d20
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-700italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-800.woff2 b/fonts/open-sans-v17-all-charsets-800.woff2
new file mode 100644
index 00000000..c94a223b
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-800.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-800italic.woff2 b/fonts/open-sans-v17-all-charsets-800italic.woff2
new file mode 100644
index 00000000..eed7d3c6
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-800italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-italic.woff2 b/fonts/open-sans-v17-all-charsets-italic.woff2
new file mode 100644
index 00000000..398b68a0
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-regular.woff2 b/fonts/open-sans-v17-all-charsets-regular.woff2
new file mode 100644
index 00000000..8383e94c
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-regular.woff2 differ
diff --git a/fonts/source-code-pro-v11-all-charsets-500.woff2 b/fonts/source-code-pro-v11-all-charsets-500.woff2
new file mode 100644
index 00000000..72224568
Binary files /dev/null and b/fonts/source-code-pro-v11-all-charsets-500.woff2 differ
diff --git a/highlight.css b/highlight.css
new file mode 100644
index 00000000..352c79b9
--- /dev/null
+++ b/highlight.css
@@ -0,0 +1,83 @@
+/*
+ * An increased contrast highlighting scheme loosely based on the
+ * "Base16 Atelier Dune Light" theme by Bram de Haan
+ * (http://atelierbram.github.io/syntax-highlighting/atelier-schemes/dune)
+ * Original Base16 color scheme by Chris Kempson
+ * (https://github.com/chriskempson/base16)
+ */
+
+/* Comment */
+.hljs-comment,
+.hljs-quote {
+ color: #575757;
+}
+
+/* Red */
+.hljs-variable,
+.hljs-template-variable,
+.hljs-attribute,
+.hljs-attr,
+.hljs-tag,
+.hljs-name,
+.hljs-regexp,
+.hljs-link,
+.hljs-name,
+.hljs-selector-id,
+.hljs-selector-class {
+ color: #d70025;
+}
+
+/* Orange */
+.hljs-number,
+.hljs-meta,
+.hljs-built_in,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params {
+ color: #b21e00;
+}
+
+/* Green */
+.hljs-string,
+.hljs-symbol,
+.hljs-bullet {
+ color: #008200;
+}
+
+/* Blue */
+.hljs-title,
+.hljs-section {
+ color: #0030f2;
+}
+
+/* Purple */
+.hljs-keyword,
+.hljs-selector-tag {
+ color: #9d00ec;
+}
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #f6f7f6;
+ color: #000;
+}
+
+.hljs-emphasis {
+ font-style: italic;
+}
+
+.hljs-strong {
+ font-weight: bold;
+}
+
+.hljs-addition {
+ color: #22863a;
+ background-color: #f0fff4;
+}
+
+.hljs-deletion {
+ color: #b31d28;
+ background-color: #ffeef0;
+}
diff --git a/highlight.js b/highlight.js
new file mode 100644
index 00000000..18d24345
--- /dev/null
+++ b/highlight.js
@@ -0,0 +1,54 @@
+/*
+ Highlight.js 10.1.1 (93fd0d73)
+ License: BSD-3-Clause
+ Copyright (c) 2006-2020, Ivan Sagalaev
+*/
+var hljs=function(){"use strict";function e(n){Object.freeze(n);var t="function"==typeof n;return Object.getOwnPropertyNames(n).forEach((function(r){!Object.hasOwnProperty.call(n,r)||null===n[r]||"object"!=typeof n[r]&&"function"!=typeof n[r]||t&&("caller"===r||"callee"===r||"arguments"===r)||Object.isFrozen(n[r])||e(n[r])})),n}class n{constructor(e){void 0===e.data&&(e.data={}),this.data=e.data}ignoreMatch(){this.ignore=!0}}function t(e){return e.replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")}function r(e,...n){var t={};for(const n in e)t[n]=e[n];return n.forEach((function(e){for(const n in e)t[n]=e[n]})),t}function a(e){return e.nodeName.toLowerCase()}var i=Object.freeze({__proto__:null,escapeHTML:t,inherit:r,nodeStream:function(e){var n=[];return function e(t,r){for(var i=t.firstChild;i;i=i.nextSibling)3===i.nodeType?r+=i.nodeValue.length:1===i.nodeType&&(n.push({event:"start",offset:r,node:i}),r=e(i,r),a(i).match(/br|hr|img|input/)||n.push({event:"stop",offset:r,node:i}));return r}(e,0),n},mergeStreams:function(e,n,r){var i=0,s="",o=[];function l(){return e.length&&n.length?e[0].offset!==n[0].offset?e[0].offset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ How we estimate instance workload
+Workload (or intensity of use) of instances is estimated using CPU load level as a proxy.
+Estimating instances workload for AWS
+The CPU load of AWS instances is retrieved using AWS Cloudwatch CPU metrics summary.
+Cloud scanner uses a sampling period of 15 minutes, but impacts metrics are returned as impacts equivalent to one hour of use.
+This means that instance impacts metrics data returned can be understood as: impact for one hour of use (considering the CPU workload of 15 last minutes).
Why this default sampling period of 15 minutes ?
+-
+
- It is sufficient for our current monitoring needs (but maybe we may make this setting configurable in the future). +
- It is hard to go below 10 minutes. Default (and free) period of AWS instance metrics is 5 minutes. You need to activate
detailed monitoring(extra feature) for 1 minute granularity: List the available CloudWatch metrics for your instances - Amazon Elastic Compute Cloud).
+
Estimating instances workload for Azure
+Not implemented.
+ +":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/how-to/deploy-sls.html b/how-to/deploy-sls.html
new file mode 100644
index 00000000..0ad85bd6
--- /dev/null
+++ b/how-to/deploy-sls.html
@@ -0,0 +1,275 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Building cloud-scanner CLI with Cargo 🦀
+On Linux
+Install Rust and linux-musl dependencies.
+# Install rust (see https://www.rust-lang.org/tools/install), validate when prompted
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+source "$HOME/.cargo/env"
+# Add Linux musl target (needed for cross compilation for aws lambda)
+rustup target add x86_64-unknown-linux-musl
+
+sudo apt update && sudo apt install -y musl-tools musl-dev
+
+# Test a build
+cargo build
+
+# build a release
+cargo build --release
+On Windows with WSL2
+Tested method to build Rust on Windows is to use Windows Subsystem For Linux (WSL2)
+-
+
- Prerequisite: install WSL2 and the latest Ubuntu LTS image (22.04). +If you do not WSL yet, you may inspire from Set up Node.js on WSL 2. +
- After WSL is setup, follow Linux instructions above inside the Linux VM. +
Using docker
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/how-to/docker-guide.html b/how-to/docker-guide.html
new file mode 100644
index 00000000..c03ec8c1
--- /dev/null
+++ b/how-to/docker-guide.html
@@ -0,0 +1,223 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Deploy cloud scanner as a serverless application
+You can deploy cloud scanner as a serverless application (AWS lambda).
+The application is build and deployed using the serverless framework (see serverless-design).
+Using Linux
+-
+
- Install Rust +
- Install nvm, nodejs +
- test serverless package +
First, don’t forget to clone the repo using
+git clone https://github.com/Boavizta/cloud-scanner.git
+cd cloud-scanner
+Install Rust
+# Install rust (see https://www.rust-lang.org/tools/install), validate when prompted
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+source "$HOME/.cargo/env"
+# Add Linux musl target (needed for cross compilation for lambda)
+rustup target add x86_64-unknown-linux-musl
+
+sudo apt update && sudo apt install -y musl-tools musl-dev
+Install node (for serverless deployment)
+nvm, node.js and npm
+See https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl
+sudo apt-get install curl
+
+# Install nvm
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
+# Install node
+nvm install --lts
+Install serverless framework and deps
+npm install -g serverless
+npm i
+Configure environment
+Everything you need should now be installed, but there is a last step you have to do before deploying. Since the serverless framework automatically deploys the lambda onto your AWS instance without you having to upload a zip file or anything, you have to give it access to it by giving it an access key (see this guide for more informations on how to generate an access keys).
+serverless config credentials \
+ --provider aws \
+ --key YOURACCESSKEY \
+ --secret YOURSECRETKEY
+Optionally, you can config a private instance of Boaviztapi by setting the environment variable BOAVIZTA_API_URL so :
export BOAVIZTA_API_URL="boaviztapi.example.com"
+If the environment variable is not set, cloud scanner will use the public instance (https://api.boavizta.org) by default.
+Deploy
+You should be good to go by now, simply run
+serverless package
+serverless deploy
+and wait for it to be done. You should by now see two lamda functions appear on your AWS instance, Congratulations !
+If any error happen, redo those steps carefully and make sure you didn’t miss anything before posting a GitHub Issue.
+Using Windows
+Tested method to deploy this serverless app from on windows is to use Windows Subsystem For Linux (WSL2).
+-
+
- Prerequisite: install WSL2 and the latest Ubuntu LTS image (22.04). +If you do not have it yet, you may inspire from Set up Node.js on WSL 2. +
- After WSL is setup, follow Linux instructions above inside the Linux VM. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/how-to/estimate-from-existing-inventory-file.html b/how-to/estimate-from-existing-inventory-file.html
new file mode 100644
index 00000000..1849af9c
--- /dev/null
+++ b/how-to/estimate-from-existing-inventory-file.html
@@ -0,0 +1,242 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Usage with Docker 🐳
+Build a local docker image
+# Local build of docker image
+docker build . --tag cloud-scanner-cli
+# Test run
+docker run -it cloud-scanner-cli --help
+Run cloud-scanner as a docker image
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/how-to/filter-by-tags.html b/how-to/filter-by-tags.html
new file mode 100644
index 00000000..66095a0d
--- /dev/null
+++ b/how-to/filter-by-tags.html
@@ -0,0 +1,269 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get impacts of an existing inventory file
+You can use cloud scanner to take a snapshot of an existing inventory and run estimation of impacts later.
+Get an inventory file
+From command line
+# Save an inventory to file
+cloud-scanner inventory > my_inventory.json
+Using http server / API mode
+# start server
+cloud-scanner serve
+# get the inventory
+curl -X 'GET' \
+ 'http://localhost:8000/inventory?aws_region=eu-west-3&include_block_storage=true' \
+ -H 'accept: application/json' > my_inventory.json
+Get estimate for a existing inventory
+From command line
+You have to explicitly pass the duration of use for which you would like to retrieve the estimation.
+# Get impacts of an existing inventory
+cloud-scanner estimate --use-duration-hours 1 --inventory-file my_inventory.json
+Using http server / API mode
+You have to explicitly pass the duration of use for which you would like to retrieve the estimation.
+# start server
+cloud-scanner serve
+# Post the previously saved inventory (my_inventory.json) for estimate
+curl -X POST -H "Content-Type: application/json" -d @my_inventory.json http://localhost:8000/impacts-from-arbitrary-inventory\?use_duration_hours\=10\&verbose_output\=false
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/how-to/passing-aws-credentials.html b/how-to/passing-aws-credentials.html
new file mode 100644
index 00000000..6aca20e4
--- /dev/null
+++ b/how-to/passing-aws-credentials.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Filter by tags
+You can limit cloud-scanner results (metriccs or json) to the cloud resources that match specific tags.
+You can use multiple tags.
+Works with inventory or estimates.
+Filter in cli
+# Retrieve only resources with the following tags:
+# CustomTagNameForDebug=olivierdemeringoadm
+# and
+# Name=test-boavizta
+cargo run -- -t Name=test-boavizta-2 -t CreatorName=olivierdemeringoadm inventory| jq
+Filter (with serverless/lambda)
+Use one (or multiple) filter_tag parameter in the query string to restrict results.
# Retrieve only resources with the following tags:
+# CustomTagNameForDebug=olivierdemeringoadm
+# and
+# Name=test-boavizta
+https://<EDITED>.execute-api.eu-west-1.amazonaws.com/dev/scan?use_duration_hours=5&aws_region=eu-west-1&filter_tag=CustomTagNameForDebug=olivierdemeringoadm&filter_tag=Name=test-boavizta
+Filter metrics
+Use the filter_tag query parameter in the URL.
It can be used multiple time (only instances matching all tags will be returned).
+Example queries
+-
+
- http://localhost:8000/metrics?aws_region=eu-west-3&filter_tag=Name=boatest&filter_tag=OtherTag=other-value +
- http://localhost:8000/metrics?aws_region=eu-west-3&filter_tag=Name=boatest +
- http://localhost:8000/metrics?aws_region=eu-west-1&filter_tag=Name=test-boavizta +
Important limitation
+Suppose the following instances (and tags)
+-
+
-
+
instance1 (
+-
+
- ENV=prod +
- PURPOSE=CI +
+ -
+
instance2
+-
+
- ENV=prod +
- PURPOSE=service +
+ -
+
Filtering on “ENV=prod” will return instance1 and instance2
+
+ -
+
Filtering on “ENV=prod” and PURPOSE=CI will return only instance2
+
+ -
+
No filter will return all instances
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/how-to/set-up-dashboard.html b/how-to/set-up-dashboard.html
new file mode 100644
index 00000000..db713ab9
--- /dev/null
+++ b/how-to/set-up-dashboard.html
@@ -0,0 +1,265 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AWS authentication
+Cloud scanner uses AWS Rust SDK to query AWS account. By default Rust SDK picks up AWS credentials from environment variables.
+AWS permissions required by Cloud Scanner
+🔥 An Important pre-requisite is to have a user with sufficient permissions to list resources of the account (or an instance profile / role pre-configured when running cloud-scanner from EC2).
+The minimal set of permissions to perform inventory of resources (and query CPU load of instances) is:
+-
+
- ec2:DescribeInstances +
- cloudwatch:GetMetricStatistics +
- cloudwatch:DescribeAlarm +
You could also restricts permissions to a specific set of instances or resources.
+Pass credentials as environment variables
+Option 1: Use AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
+Set environment variables with your account detail.
+# Example for Linux / macOS
+export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
+export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+export AWS_DEFAULT_REGION=eu-west-1
+See https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html for equivalent Windows command prompt or Powershell syntax example.
+Option 2: Use a an existing AWS_PROFILE
+If you have configured an AWS CLI profile, the easiest way to pass aws credential to cloud scanner is use an environment variable that points to this profile.
+Pre-requisite to use a profile:
+-
+
- AWS CLI installed: Installing or updating the latest version of the AWS CLI - AWS Command Line Interface +
- AWS CLI configured: Configure the AWS CLI - AWS Command Line Interface. +
# Example for Linux / macOS
+# cloud-scanner can use the AWS_PROFILE set as en environment variable.
+# You have to reference one of the profiles previously configured in ~/.aws/credentials
+export AWS_PROFILE=YOUR_PROFILE_NAME_EXAMPLE
+export AWS_DEFAULT_REGION=eu-west-3
+See https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html for equivalent Windows command prompt or Powershell syntax example.
+Reference
+See Specify your credentials and default Region - AWS SDK for Rust for more options to pass credentials to the SDK.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/how-to/simulate-impacts-of-an-inventory.html b/how-to/simulate-impacts-of-an-inventory.html
new file mode 100644
index 00000000..dbfba0d7
--- /dev/null
+++ b/how-to/simulate-impacts-of-an-inventory.html
@@ -0,0 +1,223 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Integrate metrics to a monitoring dashboard
+Cloud-scanner can be used to export metrics related to the impact of your cloud account.
+The metrics are exposed in Prometheus/OpenMetrics format. You can use it to feed a monitoring dashboard and keep an eye on the evolution of impacts of your usage.
+
Overview
+-
+
- Start cloud-scanner in metrics mode (using the
--serveoption or by deploying it as a serverless application).
+ - Setup Prometheus to scrape the metrics. Metrics are generated separately for each region. +
- Configure a dashboard to display the results. +
Detailed steps
+Demo for some EU regions.
+You can refer to the provided docker compose example for a quick start.
+It comes preconfigured to generate metrics for the following regions:
+-
+
- eu-west-1 +
- eu-west-3 +
- eu-central-1 +
- us-east-1 +
Generating metrics for additional regions.
+Examples of Prometheus and Grafana configuration files are located in the dashboard-config directories.
+To generate (and display) metrics for an additional region:
+-
+
- Edit the prometheus configuration (
prometheus.yml)
+ - Add a new job and set its region parameter like
aws_region: ['us-east-2'].
+ - Restart Prometheus container and verify that metrics are now collected for this region. +
In the exemple compose stack, prometheus admin GUI is exposed. You can check status of the scrape targets at: http://localhost:9090/targets.
+# Extract from prometheus.yml
+# Example extra job configuration to cover us-east-2
+ - job_name: 'cloud-scanner-metrics-us-east-2'
+ scheme: http
+ static_configs:
+ - targets: ['cloud_scanner_boa:8000']
+ labels:
+ group: 'production'
+ metrics_path: '/metrics'
+ params:
+ aws_region: ['us-east-2']
+ include_block_storage: ['true']
+Adapting configuration for production use:
+In production environment, you may want to increase the metrics scraping interval.
+This It is set to 30 seconds in the sample prometheus configuration. In production you shoud increase this intervall (e.g. 10 minutes).
+# Prometheus scrapping interval / extract from prometheus.yml configuration
+global:
+ scrape_interval: 30s # By default, scrape targets every 30 seconds.
+ evaluation_interval: 30s # Evaluate rules every 30 seconds.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/how-to/using-private-boaviztapi.html b/how-to/using-private-boaviztapi.html
new file mode 100644
index 00000000..808beef9
--- /dev/null
+++ b/how-to/using-private-boaviztapi.html
@@ -0,0 +1,219 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get impacts of an arbitrary inventory
+This is useful to simulate the impacts of a non-existing infrastructure or a variant of existing infrastructure.
+This involves building an inventory file and passing it to cloud scanner for evaluation.
+-
+
- describe an arbitrary inventory (the to-be infrastructure) as a json file. +
- request cloud scanner to estimate impacts of this inventory. +
💡 It may be easier to adapt an existing inventory file, rather than creating it from scratch. See Estimate the impacts of an existing inventory.
+The JSON schema of the inventory file is in the git repository: cloud-scanner/cloud-scanner-cli/test-data/INVENTORY_JSON_SCHEMA.json. This schema can also be retrieved with the command cargo run inventory --print-json-schema.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/images/CS-dashboard.png b/images/CS-dashboard.png
new file mode 100644
index 00000000..64d3737e
Binary files /dev/null and b/images/CS-dashboard.png differ
diff --git a/images/cloud-scanner-dashboard-clear.png b/images/cloud-scanner-dashboard-clear.png
new file mode 100644
index 00000000..091117ac
Binary files /dev/null and b/images/cloud-scanner-dashboard-clear.png differ
diff --git a/images/cloud-scanner-dashboard-dark.png b/images/cloud-scanner-dashboard-dark.png
new file mode 100644
index 00000000..167c31d8
Binary files /dev/null and b/images/cloud-scanner-dashboard-dark.png differ
diff --git a/images/cloud-scanner-lambda-deployment.excalidraw.png b/images/cloud-scanner-lambda-deployment.excalidraw.png
new file mode 100644
index 00000000..d6038302
Binary files /dev/null and b/images/cloud-scanner-lambda-deployment.excalidraw.png differ
diff --git a/images/cloud-scanner-metrics-compose.excalidraw.png b/images/cloud-scanner-metrics-compose.excalidraw.png
new file mode 100644
index 00000000..ac09eb59
Binary files /dev/null and b/images/cloud-scanner-metrics-compose.excalidraw.png differ
diff --git a/images/cloud-scanner-perimeter-aws.excalidraw.png b/images/cloud-scanner-perimeter-aws.excalidraw.png
new file mode 100644
index 00000000..b408c8c8
Binary files /dev/null and b/images/cloud-scanner-perimeter-aws.excalidraw.png differ
diff --git a/images/cloud-scanner-system-in-context.png b/images/cloud-scanner-system-in-context.png
new file mode 100644
index 00000000..a3a43d7e
Binary files /dev/null and b/images/cloud-scanner-system-in-context.png differ
diff --git a/images/cloudscanner_color_logo.svg b/images/cloudscanner_color_logo.svg
new file mode 100644
index 00000000..ed4a010f
--- /dev/null
+++ b/images/cloudscanner_color_logo.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/index.html b/index.html
new file mode 100644
index 00000000..c166f6ec
--- /dev/null
+++ b/index.html
@@ -0,0 +1,242 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Using a private instance of Boavizta API
+To avoid that the scanner shares your inventory data to the public version of Boavizta API, It is recommended to deploy your own instance of Boavizta API.
+This is also useful if you want to stick to a specific version of the API.
+The Boavizta API can be deployed in several ways (docker, lambda a.s.o.). Refer to the API documentation: Deploy - Boavizta API documentation or refer to the provided docker compose example for an example of integration cloud-scanner and a private instance of the API.
+Once you have deployed your instance of API, use either the command line flags (CLI) or environment variable (docker, lambda) to configure the scanner to use your API instance.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/intro.html b/intro.html
new file mode 100644
index 00000000..c166f6ec
--- /dev/null
+++ b/intro.html
@@ -0,0 +1,242 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 
About cloud-scanner
+Boavizta Cloud-scanner returns environmental impacts of your AWS Instances (EC2) and Storage usage.
+graph LR; + inventory[ Account inventory] + api[Impacts from BoaviztaAPI] + metrics[Prometheus metrics] + json[JSON output] + inventory --> api + api --> metrics + api --> json ++
It 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.
+-
+
- multi criteria: Primary Energy consumption (PE), Abiotic resource depletion potential (ADP), and Global Warming Potential (GWP) +
- multi stage: separate impacts of ressources Usage and Manufacture +
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 📊 +
Cloud-scanner is an Open Source application maintained here: https://github.com/Boavizta/cloud-scanner.
+How it works
+
Cloud scanner relies on cloud providers APIs to perform an inventory of your cloud resources. It collects information about usage (instance types, tags, CPU load or volume size).
+This inventory is used to query Boavizta API which returns impact data.
+Results are exposed as JSON or metrics.
+Contributing
+Cloud scanner is stable, but with limited functionality.
+Development versions may already provide new functionalities that have not yet be included to a release. So have a look at the changelog and Issues on this repository.
+And most importantly, do not hesitate to ask questions or share your feedback by opening an Issue or discussion on GitHub.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/mark.min.js b/mark.min.js
new file mode 100644
index 00000000..16362318
--- /dev/null
+++ b/mark.min.js
@@ -0,0 +1,7 @@
+/*!***************************************************
+* mark.js v8.11.1
+* https://markjs.io/
+* Copyright (c) 2014–2018, Julian Kühnel
+* Released under the MIT license https://git.io/vwTVl
+*****************************************************/
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
About cloud-scanner
+Boavizta Cloud-scanner returns environmental impacts of your AWS Instances (EC2) and Storage usage.
+graph LR; + inventory[ Account inventory] + api[Impacts from BoaviztaAPI] + metrics[Prometheus metrics] + json[JSON output] + inventory --> api + api --> metrics + api --> json ++
It 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.
+-
+
- multi criteria: Primary Energy consumption (PE), Abiotic resource depletion potential (ADP), and Global Warming Potential (GWP) +
- multi stage: separate impacts of ressources Usage and Manufacture +
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 📊 +
Cloud-scanner is an Open Source application maintained here: https://github.com/Boavizta/cloud-scanner.
+How it works
+
Cloud scanner relies on cloud providers APIs to perform an inventory of your cloud resources. It collects information about usage (instance types, tags, CPU load or volume size).
+This inventory is used to query Boavizta API which returns impact data.
+Results are exposed as JSON or metrics.
+Contributing
+Cloud scanner is stable, but with limited functionality.
+Development versions may already provide new functionalities that have not yet be included to a release. So have a look at the changelog and Issues on this repository.
+And most importantly, do not hesitate to ask questions or share your feedback by opening an Issue or discussion on GitHub.
+ +"),zk=t=>t.replace(If,"#br#"),aG=t=>{let e="";return t&&(e=window.location.protocol+"//"+window.location.host+window.location.pathname+window.location.search,e=e.replaceAll(/\(/g,"\\("),e=e.replaceAll(/\)/g,"\\)")),e},Mr=t=>!(t===!1||["false","null","0"].includes(String(t).trim().toLowerCase())),ja=function(t){let e=t;return t.indexOf("~")!==-1?(e=e.replace(/~([^~].*)/,"<$1"),e=e.replace(/~([^~]*)$/,">$1"),ja(e)):e},pe={getRows:tG,sanitizeText:ai,sanitizeTextOrArray:eG,hasBreaks:rG,splitBreaks:nG,lineBreakRegex:If,removeScript:qk,getUrl:aG,evaluate:Mr},Nf={min:{r:0,g:0,b:0,s:0,l:0,a:0},max:{r:255,g:255,b:255,h:360,s:100,l:100,a:1},clamp:{r:t=>t>=255?255:t<0?0:t,g:t=>t>=255?255:t<0?0:t,b:t=>t>=255?255:t<0?0:t,h:t=>t%360,s:t=>t>=100?100:t<0?0:t,l:t=>t>=100?100:t<0?0:t,a:t=>t>=1?1:t<0?0:t},toLinear:t=>{const e=t/255;return t>.03928?Math.pow((e+.055)/1.055,2.4):e/12.92},hue2rgb:(t,e,r)=>(r<0&&(r+=1),r>1&&(r-=1),r<1/6?t+(e-t)*6*r:r<1/2?e:r<2/3?t+(e-t)*(2/3-r)*6:t),hsl2rgb:({h:t,s:e,l:r},n)=>{if(!e)return r*2.55;t/=360,e/=100,r/=100;const i=r<.5?r*(1+e):r+e-r*e,a=2*r-i;switch(n){case"r":return Nf.hue2rgb(a,i,t+1/3)*255;case"g":return Nf.hue2rgb(a,i,t)*255;case"b":return Nf.hue2rgb(a,i,t-1/3)*255}},rgb2hsl:({r:t,g:e,b:r},n)=>{t/=255,e/=255,r/=255;const i=Math.max(t,e,r),a=Math.min(t,e,r),s=(i+a)/2;if(n==="l")return s*100;if(i===a)return 0;const o=i-a,l=s>.5?o/(2-i-a):o/(i+a);if(n==="s")return l*100;switch(i){case t:return((e-r)/o+(e
"},r),pe.lineBreakRegex.test(t)))return t;const n=t.split(" "),i=[];let a="";return n.forEach((s,o)=>{const l=Bi(`${s} `,r),u=Bi(a,r);if(l>e){const{hyphenatedStrings:f,remainingWord:p}=lX(s,e,"-",r);i.push(a,...f),a=p}else u+l>=e?(i.push(a),a=s):a=[a,s].filter(Boolean).join(" ");o+1===n.length&&i.push(a)}),i.filter(s=>s!=="").join(r.joinWith)},(t,e,r)=>`${t}${e}${r.fontSize}${r.fontWeight}${r.fontFamily}${r.joinWith}`),lX=Gf((t,e,r="-",n)=>{n=Object.assign({fontSize:12,fontWeight:400,fontFamily:"Arial",margin:0},n);const i=t.split(""),a=[];let s="";return i.forEach((o,l)=>{const u=`${s}${o}`;if(Bi(u,n)>=e){const d=l+1,f=i.length===d,p=`${u}${r}`;a.push(f?u:p),s=""}else s=u}),{hyphenatedStrings:a,remainingWord:s}},(t,e,r="-",n)=>`${t}${e}${r}${n.fontSize}${n.fontWeight}${n.fontFamily}`),eg=function(t,e){return e=Object.assign({fontSize:12,fontWeight:400,fontFamily:"Arial",margin:15},e),rg(t,e).height},Bi=function(t,e){return e=Object.assign({fontSize:12,fontWeight:400,fontFamily:"Arial"},e),rg(t,e).width},rg=Gf(function(t,e){e=Object.assign({fontSize:12,fontWeight:400,fontFamily:"Arial"},e);const{fontSize:r,fontFamily:n,fontWeight:i}=e;if(!t)return{width:0,height:0};const a=["sans-serif",n],s=t.split(pe.lineBreakRegex),o=[],l=St("body");if(!l.remove)return{width:0,height:0,lineHeight:0};const u=l.append("svg");for(const d of a){let f=0;const p={width:0,height:0,lineHeight:0};for(const m of s){const _=sX();_.text=m;const y=oX(u,_).style("font-size",r).style("font-weight",i).style("font-family",d),b=(y._groups||y)[0][0].getBBox();p.width=Math.round(Math.max(p.width,b.width)),f=Math.round(b.height),p.height+=f,p.lineHeight=Math.round(Math.max(p.lineHeight,f))}o.push(p)}u.remove();const h=isNaN(o[1].height)||isNaN(o[1].width)||isNaN(o[1].lineHeight)||o[0].height>o[1].height&&o[0].width>o[1].width&&o[0].lineHeight>o[1].lineHeight?0:1;return o[h]},(t,e)=>`${t}${e.fontSize}${e.fontWeight}${e.fontFamily}`),cX=class{constructor(e,r){this.deterministic=e,this.seed=r,this.count=r?r.length:0}next(){return this.deterministic?this.count++:Date.now()}};let jf;const uX=function(t){return jf=jf||document.createElement("div"),t=escape(t).replace(/%26/g,"&").replace(/%23/g,"#").replace(/%3B/g,";"),jf.innerHTML=t,unescape(jf.textContent)},Vs=t=>{if(H.debug("directiveSanitizer called with",t),typeof t=="object"&&(t.length?t.forEach(e=>Vs(e)):Object.keys(t).forEach(e=>{H.debug("Checking key",e),e.indexOf("__")===0&&(H.debug("sanitize deleting __ option",e),delete t[e]),e.indexOf("proto")>=0&&(H.debug("sanitize deleting proto option",e),delete t[e]),e.indexOf("constr")>=0&&(H.debug("sanitize deleting constr option",e),delete t[e]),e.indexOf("themeCSS")>=0&&(H.debug("sanitizing themeCss option"),t[e]=$f(t[e])),e.indexOf("fontFamily")>=0&&(H.debug("sanitizing fontFamily option"),t[e]=$f(t[e])),e.indexOf("altFontFamily")>=0&&(H.debug("sanitizing altFontFamily option"),t[e]=$f(t[e])),vG.indexOf(e)<0?(H.debug("sanitize deleting option",e),delete t[e]):typeof t[e]=="object"&&(H.debug("sanitize deleting object",e),Vs(t[e]))})),t.themeVariables){const e=Object.keys(t.themeVariables);for(let r=0;r