Skip to content

Latest commit

 

History

History
118 lines (77 loc) · 7.51 KB

index.md

File metadata and controls

118 lines (77 loc) · 7.51 KB
Raw
repository title description
AWS Insights Mod - Visualize and report on resource configuration across your AWS accounts.
DevOps pros use these dashboards to analyze cloud metrics, report on resource config, and enhance cloud security with interactive visualizations built using HCL and SQL.

AWS Insights Mod - Visualize and report on resource configuration across your AWS accounts.

DevOps professionals use the AWS insights mod to visualize cloud intelligence and security metrics using interactive dashboards. Report on AWS resource configuration, visualize relationships, and aggregate metrics to better understand your cloud infrastructure. The dashboards are specified using a "low code" HCL format (similar to Terraform). Making it easy to inspect, modify and compose new dashboards to meet specific compliance and security objectives for your organization.

Screenshot of 'AWS S3 Bucket Dashboard' on 'pipes.turbot.com' with metrics on bucket privacy, encryption, logging, and costs.

Screenshot of 'AWS S3 Bucket Dashboard' on 'pipes.turbot.com' with metrics on bucket privacy, encryption, logging, and costs.

'AWS S3 Bucket Dashboard' example using 'pipes.turbot.com' showing metrics on bucket privacy, encryption, logging, and costs.

Example of the 'AWS S3 Bucket Dashboard' with metrics on bucket privacy, encryption, logging, and costs.

Detailed report for AWS S3 bucket 'ria-example-test'. Highlights: no public access, encryption on, logging off. Shows AWS service connections.

Dashboard for 'AWS EBS Snapshot Age Report' with filters like '<24 hours', '1-30 Days', and '>1 Year'. Table columns include Snapshot ID, Name, Age, and Region.

'AWS EBS Volume Encryption Report' dashboard highlighting 'Unencrypted' volumes. Table columns: Volume ID, Name, Encryption status, and Region.

'AWS EC2 Instance Public Access Report' from Steampipe showing 5 instances with 1 publicly accessible. Table includes Instance ID, Name, and access status.

Dashboard for 'AWS IAM Policy Detail' from Steampipe. Top section has a policy selector. Main section shows policy's relationships with AWS services.

Detailed dashboard of AWS VPC 'VPC Test' detailing relationships with resources like CIDR blocks, subnets, and security groups.

Visualization of AWS VPC Security Group 'default'. Details on ingress/egress rules and associated AWS connections.

Overview

Resource type Dashboards have interactive elements that can answer questions like:

  • How many of this resource type do I have?
  • Counts by accounts and regions?
  • Cost of these resources over time.
  • Percentage of resources that are configured in specific ways (e.g. encryption on?)
  • How old are my resources?

Resource detail reports can be reached by drilling down from dashboards or manually selecting the resource name. They drill into a specific resource and can answer detailed configuration questions and provide a visualization of relationships to other resources. Use these to answer deep questions:

  • What are the relationships between this resource and others?
  • Is this resource publicly accessible?
  • Is encryption enabled and what keys are used for encryption?
  • Is versioning enabled?
  • What networking ingress and egress rules are associated with this resource.

Dashboards are available for 15+ services, including CloudTrail, EC2, IAM, RDS, S3, VPC, and more!

References

AWS provides on-demand cloud computing platforms and APIs to authenticated customers on a metered pay-as-you-go basis.

Steampipe is an open source CLI to instantly query cloud APIs using SQL.

Steampipe Mods are collections of named queries, codified controls that can be used to test current configuration of your cloud resources against a desired configuration, and dashboards that organize and display key pieces of information.

Documentation

Getting started

Installation

Download and install Steampipe (https://steampipe.io/downloads). Or use Brew:

brew tap turbot/tap
brew install steampipe

Install the AWS plugin with Steampipe:

steampipe plugin install aws

Clone:

git clone https://github.com/turbot/steampipe-mod-aws-insights.git
cd steampipe-mod-aws-insights

Usage

Before running any dashboards, it's recommended to generate your AWS credential report:

aws iam generate-credential-report

Start your dashboard server to get started:

steampipe dashboard

By default, the dashboard interface will then be launched in a new browser window at http://localhost:9194. From here, you can view dashboards and reports.

Credentials

This mod uses the credentials configured in the Steampipe AWS plugin.

Configuration

No extra configuration is required.

Contributing

If you have an idea for additional dashboards or just want to help maintain and extend this mod (or others) we would love you to join the community and start contributing.

Please see the contribution guidelines and our code of conduct. All contributions are subject to the Apache 2.0 open source license.

Want to help but not sure where to start? Pick up one of the help wanted issues: