Skip to content
Scans your AWS cloud resources and generates reports
Branch: master
Clone or download
Latest commit a58639b Apr 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
sample-reports
src Update log util and disable .ejs from .npmignore Apr 8, 2019
.gitignore
.npmignore Update log util and disable .ejs from .npmignore Apr 8, 2019
LICENSE
README.md
gulpfile.js Fix copy ejs Apr 22, 2019
package-lock.json Fix copy ejs Apr 22, 2019
package.json
tsconfig.json Fix list mfa devices collector Dec 4, 2018
tslint.json Add tslint and add support for EC2 credentials Nov 28, 2018

README.md

Donate

Cloud Reports

Collects info about various cloud resources and analyzes them against best practices and give a JSON, CSV, HTML, or PDF reports.

Modules

Collectors

These collect the information about various cloud resources from the cloud provider. This information later used by Analyzers to analyze.

Analyzers

Analyzers are the codified best practices for the cloud and these analyzes each best practice against the collected information and generates report which then consumed by Reporters to generate reports in a desired format.

Reporters

These are for generating reports in various formats and currently supported formats are JSON, HTML and PDF.

AWS (Amazon Web Services)

We are implementing checks based on AWS Well Architected best practices.

Install NodeJS

This package is based on NodeJS framework so you can it install from here.

Installing cloud-reports from source

Download

git clone https://github.com/tensult/cloud-reports.git

To get updates

If you have already cloned this repository before then for getting new updates, change directory to the cloud-reports directory and then do git pull.

git pull

Installing and Building

Make sure you are in the cloud-reports directory.

To convert typescript to javascript

npm run build 

Scan

This collects and analyzes information about your AWS cloud and stores as a report file with name scan_report.pdf.

  • To run for all modules
npm run scan -- --profile Your-AWS-profile
  • To run on an EC2 instance
    • It is recommended not to keep the hard coded credentials on the instance so make sure to configure IAM EC2 instance profile role with Read access to AWS account.
    • Kindly make sure the machine has minimum 2 GB RAM available and the IAM role has atleast ReadOnly access to the AWS account.
    • Once the above conditions are met, CloudReports can run on the instance using instance profile role so no need to pass the profile parameter.
npm run scan -- --module s3,acm
  • To run for specific module
npm run scan -- --profile Your-AWS-profile --module s3,acm
  • To run for single module
npm run scan -- --profile Your-AWS-profile  --module s3
  • We can generate report in following formats:
  • To generate HTML report file
npm run scan -- --profile Your-AWS-profile  -f html
  • To generate PDF report file
npm run scan -- --profile Your-AWS-profile  -f pdf
npm run scan -- --profile Your-AWS-profile  -f pdf -i # This will only report issues
  • To generate CSV report file
npm run scan -- --profile Your-AWS-profile  -f csv
npm run scan -- --profile Your-AWS-profile  -f csv -i # This will only report issues
  • To generate JSON report file
npm run scan -- --profile Your-AWS-profile  -f json

Sample reports

Debugging

You can run this tool in debug mode to generate intermediate reports: collector_report.json and analyzer_report.json

npm run scan -- --profile Your-AWS-profile  -f pdf -d

Reusing Collector report

When we are working on analyzers, we will be testing them multiple times and every time collecting data will cause delays, to avoid such delays you can use the following command to reuse already collected collector report.

npm run scan -- --profile Your-AWS-profile  -f pdf -d -u

Install as npm module to an existing package

Install cloud-reports npm module

npm install -S cloud-reports

Usage

Make sure you have initialized AWS.config, otherwise this will use default AWS profile.

    const cloudReporter = require('cloud-reports');
    // To collect for all modules
    const collectionPromise = cloudReporter.collect()
    // To collect for specific modules
    // const collectedJson = cloudReporter.collect(['s3', 'iam']);
    // const collectedJson = cloudReporter.collect('vpc');
    const analysisPromise = collectionPromise.then((collectedJson) => cloudReporter.analyze(collectedJson));
    analysisPromise.then((analysisJson) => console.log(JSON.stringify(analysisJson, null, 2)));

Multiple credentials support

You may want to run the report for multiple accounts with different set of credentials at once, then in that case you can pass different credentials to collect method.

    const cloudReporter = require('cloud-reports');
    const account1CollectionPromise = cloudReporter.collect(all, credentials1);
    const account2CollectionPromise = cloudReporter.collect(all, credentials2);

    const analysisPromise = Promise.all([account1CollectionPromise, account2CollectionPromise])
                                   .then((collectedJsons) => {
                                       return collectedJsons.map((collectedJson) => {
                                           return cloudReporter.analyze(collectedJson);
                                       });
                                    });
    analysisPromise.then((analysisJsons) => console.log(JSON.stringify(analysisJsons, null, 2)));

Update service regions

We have written a script which updates the AWS regions data

node src/scripts/updateAwsServiceRegionsData.js

Contribute

Currently this application only supports AWS, but can be extendable to other cloud providers. Contributions are most welcome.

Contact us

This product is supported and actively developed by Tensult. You can contact us at info@tensult.com.

You can’t perform that action at this time.