Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Scans your AWS cloud resources and generates reports. Check out free hosted version:
https://github.com/tensult/cloud-reports

analyzer aws best-practices cloud cloud-computing html json pdf puppeteer reports scans security

Last synced: 3 months ago
JSON representation

Scans your AWS cloud resources and generates reports. Check out free hosted version:

Host: GitHub
URL: https://github.com/tensult/cloud-reports
Owner: tensult
License: gpl-3.0
Archived: true
Created: 2017-11-24T04:03:47.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2020-12-12T07:40:44.000Z (almost 4 years ago)
Last Synced: 2024-06-28T10:31:56.792Z (4 months ago)
Topics: analyzer, aws, best-practices, cloud, cloud-computing, html, json, pdf, puppeteer, reports, scans, security
Language: TypeScript
Homepage: https://apps.tensult.com
Size: 2.47 MB
Stars: 276
Watchers: 13
Forks: 61
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Board Status](https://dev.azure.com/tensult/2c29ab5b-9000-4fa6-9749-f4e61e2ade0f/cf3227c2-a417-4152-9b04-adb28ea85230/_apis/work/boardbadge/fc868809-c7e9-4f6b-9d31-c36850a90084)](https://dev.azure.com/tensult/2c29ab5b-9000-4fa6-9749-f4e61e2ade0f/_boards/board/t/cf3227c2-a417-4152-9b04-adb28ea85230/Microsoft.RequirementCategory)

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=73QY55FZWSPRJ)

# 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](https://github.com/tensult/cloud-reports/tree/master/src/collectors)

These collect the information about various cloud resources from the cloud provider. This information later used by [Analyzers](https://github.com/tensult/cloud-reports/tree/master/src/analyzers) to analyze.

### [Analyzers](https://github.com/tensult/cloud-reports/tree/master/src/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](https://github.com/tensult/cloud-reports/tree/master/src/reporters) to generate reports in a desired format.

### [Reporters](https://github.com/tensult/cloud-reports/tree/master/src/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](https://aws.amazon.com/architecture/well-architected/) best practices. 

* [AWS Collectors](https://github.com/tensult/cloud-reports/tree/master/src/collectors/aws): Collects information from various AWS services.

* [AWS Analyzers](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws): Analyzes the information collected.

* Currently supported AWS service modules:

* * acm: [AWS Certificate Manager](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/acm)

* * apigateway: [Amazon APIGateway](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/apigateway)

* * cloudfront: [AWS CloudFront](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/cloudfront)

* * cloudwatch: [AWS CloudWatch](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/cloudwatch)

* * dynamodb: [AWS DynamoDB](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/dynamodb)

* * ebs: [AWS Elastic Block Storage](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/ebs)

* * ec2: [AWS Elastic Cloud Computing](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/ec2)

* * elasticsearch: [AWS Elasticsearch Service](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/elasticsearch)

* * elb: [AWS Elastic Load Balancer](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/elb)

* * iam: [AWS Identity and Access Management](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/iam)

* * lambda: [Amazon Lambda](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/lambda)

* * rds: [AWS Relational Databases](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/rds)

* * redshift: [AWS Redshift](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/redshift)

* * resourcegroups: [AWS Resource Groups](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/resourcegroups)

* * route53: [AWS Route 53](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/route53)

* * s3: [AWS Simple Storage Service](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/s3)

* * sns: [AWS Simple Notification Service](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/sns)

* * sqs: [AWS Simple Queue Service](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/sqs)

* * route53: [AWS Elastic Load Balancer](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/elb)

* * trails: [AWS CloudTrails](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/trails)

* * vpc: [AWS Virtual Private Cloud](https://github.com/tensult/cloud-reports/tree/master/src/analyzers/aws/vpc)

### Install NodeJS

This package is based on NodeJS framework so you can it install from [here](https://nodejs.org/en/).

### 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 -- -m s3,acm

```

* To run for specific module

```

npm run scan -- --profile Your-AWS-profile -m s3,acm

```

* To run for single module

```

npm run scan -- --profile Your-AWS-profile  -m s3

```

* To run for specific regions

```

npm run scan -- --profile Your-AWS-profile -m s3,acm -r ap-south-1,ap-southeast-1

```

* 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

```

* To generate report with custom name

```

npm run scan -- --profile Your-AWS-profile  -f json -o my-dev-account

```

#### [Sample reports](https://github.com/tensult/cloud-reports/tree/master/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](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/global-config-object.html), otherwise this will use default AWS profile.

```js

    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.

```js

    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[Broken as AWS changed the documentation UI]

We have written a [script](https://github.com/tensult/cloud-reports/blob/master/src/scripts/updateAwsServiceRegionsData.js) which updates the [AWS regions data](https://github.com/tensult/cloud-reports/blob/master/src/utils/aws/regions_data.ts)

```

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](https://www.tensult.com). You can contact us at [email protected]. Also, we have a SaaS version also for [this](https://apps.tensult.com) and currently it is free so please try it.