Merge pull request #344 from turbot/release/v0.19

Release/v0.19
turbot · Mar 6, 2024 · b64f851 · b64f851
2 parents 11a8406 + 4a7100f
commit b64f851
Show file tree

Hide file tree

Showing 16 changed files with 92 additions and 87 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -10,6 +10,9 @@ assignees: ''
 **Describe the bug**
 A clear and concise description of what the bug is.
 
+**Powerpipe version (`powerpipe -v`)**
+Example: v0.3.0
+
 **Steampipe version (`steampipe -v`)**
 Example: v0.3.0
 

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -3,6 +3,9 @@ contact_links:
   - name: Questions
     url: https://turbot.com/community/join
     about: GitHub issues in this repository are only intended for bug reports and feature requests. Other issues will be closed. Please ask and answer questions through the Steampipe Slack community.
+  - name: Powerpipe CLI Bug Reports and Feature Requests
+    url: https://github.com/turbot/powerpipe/issues/new/choose
+    about: Powerpipe CLI has its own codebase. Bug reports and feature requests for those pieces of functionality should be directed to that repository.
   - name: Steampipe CLI Bug Reports and Feature Requests
     url: https://github.com/turbot/steampipe/issues/new/choose
     about: Steampipe CLI has its own codebase. Bug reports and feature requests for those pieces of functionality should be directed to that repository.
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,7 @@
 
 # Ignore Apple custom attributes file
 .DS_Store
+
+# Powerpipe variable files
+*.ppvars
+*.auto.ppvars
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,16 @@
+## v0.19 [2024-04-06]
+
+_Powerpipe_
+
+[Powerpipe](https://powerpipe.io) is now the preferred way to run this mod!  [Migrating from Steampipe →](https://powerpipe.io/blog/migrating-from-steampipe)
+
+All v0.x versions of this mod will work in both Steampipe and Powerpipe, but v1.0.0 onwards will be in Powerpipe format only.
+
+_Enhancements_
+
+- Focus documentation on Powerpipe commands.
+- Show how to combine Powerpipe mods with Steampipe plugins.
+
 ## v0.18 [2024-02-28]
 
 _What's new?_

diff --git a/README.md b/README.md
@@ -1,4 +1,9 @@
-# AWS Insights Mod for Steampipe
+# AWS Insights Mod for Powerpipe
+
+> [!IMPORTANT]  
+> [Powerpipe](https://powerpipe.io) is now the preferred way to run this mod! [Migrating from Steampipe →](https://powerpipe.io/blog/migrating-from-steampipe)
+>
+> All v0.x versions of this mod will work in both Steampipe and Powerpipe, but v1.0.0 onwards will be in Powerpipe format only.
 
 An AWS dashboarding tool that can be used to view dashboards and reports across all of your AWS accounts.
 
@@ -15,65 +20,67 @@ Dashboards can help answer questions like:
 - Is versioning enabled?
 - What are the relationships between closely connected resources like IAM users, groups, and policies?
 
-Dashboards are available for 15+ services, including CloudTrail, EC2, IAM, RDS, S3, VPC, and more!
+Dashboards are available for 30+ services, including CloudTrail, EC2, IAM, RDS, S3, VPC, and more!
+
+## Documentation
 
-## Getting started
+- **[Dashboards →](https://hub.powerpipe.io/mods/turbot/aws_insights/dashboards)**
+
+## Getting Started
 
 ### Installation
 
-Download and install Steampipe (https://steampipe.io/downloads). Or use Brew:
+Install Powerpipe (https://powerpipe.io/downloads), or use Brew:
 
 ```sh
-brew tap turbot/tap
-brew install steampipe
+brew install turbot/tap/powerpipe
 ```
 
-Install the AWS plugin with [Steampipe](https://steampipe.io):
+This mod also requires [Steampipe](https://steampipe.io) with the [AWS plugin](https://hub.steampipe.io/plugins/turbot/aws) as the data source. Install Steampipe (https://steampipe.io/downloads), or use Brew:
 
 ```sh
+brew install turbot/tap/steampipe
 steampipe plugin install aws
 ```
 
-Clone:
+Steampipe will automatically use your default AWS credentials. Optionally, you can [setup multiple accounts](https://hub.steampipe.io/plugins/turbot/aws#multi-account-connections) or [customize AWS credentials](https://hub.steampipe.io/plugins/turbot/aws#configuring-aws-credentials).
+
+Finally, install the mod:
 
 ```sh
-git clone https://github.com/turbot/steampipe-mod-aws-insights.git
-cd steampipe-mod-aws-insights
+mkdir dashboards
+cd dashboards
+powerpipe mod init
+powerpipe mod install github.com/turbot/steampipe-mod-aws-insights
 ```
 
-### Usage
+### Browsing Dashboards
 
-Before running any dashboards, it's recommended to generate your AWS credential report:
+Start Steampipe as the data source:
 
 ```sh
-aws iam generate-credential-report
+steampipe service start
 ```
 
-Start your dashboard server to get started:
+Start the dashboard server:
 
 ```sh
-steampipe dashboard
+powerpipe server
 ```
 
-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](https://hub.steampipe.io/plugins/turbot/aws).
-
-### Configuration
+Browse and view your dashboards at **http://localhost:9033**.
 
-No extra configuration is required.
+## Open Source & Contributing
 
-## Contributing
+This repository is published under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0). Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you!
 
-If you have an idea for additional dashboards or just want to help maintain and extend this mod ([or others](https://github.com/topics/steampipe-mod)) we would love you to join the community and start contributing.
+[Steampipe](https://steampipe.io) and [Powerpipe](https://powerpipe.io) are products produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). They are distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source).
 
-- **[Join #steampipe on Slack →](https://turbot.com/community/join)** and hang out with other Mod developers.
+## Get Involved
 
-Please see the [contribution guidelines](https://github.com/turbot/steampipe/blob/main/CONTRIBUTING.md) and our [code of conduct](https://github.com/turbot/steampipe/blob/main/CODE_OF_CONDUCT.md). All contributions are subject to the [Apache 2.0 open source license](https://github.com/turbot/steampipe-mod-aws-insights/blob/main/LICENSE).
+**[Join #powerpipe on Slack →](https://turbot.com/community/join)**
 
-Want to help but not sure where to start? Pick up one of the `help wanted` issues:
+Want to help but don't know where to start? Pick up one of the `help wanted` issues:
 
-- [Steampipe](https://github.com/turbot/steampipe/labels/help%20wanted)
-- [AWS Insights Mod](https://github.com/turbot/steampipe-mod-aws-insights/labels/help%20wanted)
+- [Powerpipe](https://github.com/turbot/powerpipe/labels/help%20wanted)
+- [AWS Insights Mod](https://github.com/turbot/steampipe-mod-aws-insights/labels/help%20wanted)
diff --git a/docs/dashboards.md b/docs/dashboards.md
diff --git a/docs/images/aws_ebs_snapshot_age.png b/docs/images/aws_ebs_snapshot_age.png
diff --git a/docs/images/aws_ebs_volume_encryption.png b/docs/images/aws_ebs_volume_encryption.png
diff --git a/docs/images/aws_ec2_instance_public_access.png b/docs/images/aws_ec2_instance_public_access.png
diff --git a/docs/images/aws_iam_policy_detail.png b/docs/images/aws_iam_policy_detail.png
diff --git a/docs/images/aws_s3_bucket_dashboard.png b/docs/images/aws_s3_bucket_dashboard.png
diff --git a/docs/images/aws_s3_bucket_detail.png b/docs/images/aws_s3_bucket_detail.png
diff --git a/docs/images/aws_vpc_detail.png b/docs/images/aws_vpc_detail.png
diff --git a/docs/images/aws_vpc_security_group_detail.png b/docs/images/aws_vpc_security_group_detail.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,10 +1,4 @@
----
-repository: "https://github.com/turbot/steampipe-mod-aws-insights"
-title: "AWS Insights Mod - Visualize and report on resource configuration across your AWS accounts."
-description: "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.
+# 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.
 
@@ -34,78 +28,67 @@ Resource **detail reports** can be reached by drilling down from dashboards or m
 - 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](https://aws.amazon.com/) provides on-demand cloud computing platforms and APIs to authenticated customers on a metered pay-as-you-go basis.
-
-[Steampipe](https://steampipe.io) is an open source CLI to instantly query cloud APIs using SQL.
-
-[Steampipe Mods](https://steampipe.io/docs/reference/mod-resources#mod) 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.
+Dashboards are available for 30+ services, including CloudTrail, EC2, IAM, RDS, S3, VPC, and more!
 
 ## Documentation
 
-- **[Dashboards →](https://hub.steampipe.io/mods/turbot/aws_insights/dashboards)**
+- **[Dashboards →](https://hub.powerpipe.io/mods/turbot/aws_insights/dashboards)**
 
-## Getting started
+## Getting Started
 
 ### Installation
 
-Download and install Steampipe (https://steampipe.io/downloads). Or use Brew:
+Install Powerpipe (https://powerpipe.io/downloads), or use Brew:
 
 ```sh
-brew tap turbot/tap
-brew install steampipe
+brew install turbot/tap/powerpipe
 ```
 
-Install the AWS plugin with [Steampipe](https://steampipe.io):
+This mod also requires [Steampipe](https://steampipe.io) with the [AWS plugin](https://hub.steampipe.io/plugins/turbot/aws) as the data source. Install Steampipe (https://steampipe.io/downloads), or use Brew:
 
 ```sh
+brew install turbot/tap/steampipe
 steampipe plugin install aws
 ```
 
-Clone:
+Steampipe will automatically use your default AWS credentials. Optionally, you can [setup multiple accounts](https://hub.steampipe.io/plugins/turbot/aws#multi-account-connections) or [customize AWS credentials](https://hub.steampipe.io/plugins/turbot/aws#configuring-aws-credentials).
+
+Finally, install the mod:
 
 ```sh
-git clone https://github.com/turbot/steampipe-mod-aws-insights.git
-cd steampipe-mod-aws-insights
+mkdir dashboards
+cd dashboards
+powerpipe mod init
+powerpipe mod install github.com/turbot/steampipe-mod-aws-insights
 ```
 
-### Usage
+### Browsing Dashboards
 
-Before running any dashboards, it's recommended to generate your AWS credential report:
+Start Steampipe as the data source:
 
 ```sh
-aws iam generate-credential-report
+steampipe service start
 ```
 
-Start your dashboard server to get started:
+Start the dashboard server:
 
 ```sh
-steampipe dashboard
+powerpipe server
 ```
 
-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](https://hub.steampipe.io/plugins/turbot/aws).
-
-### Configuration
+Browse and view your dashboards at **http://localhost:9033**.
 
-No extra configuration is required.
+## Open Source & Contributing
 
-## Contributing
+This repository is published under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0). Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you!
 
-If you have an idea for additional dashboards or just want to help maintain and extend this mod ([or others](https://github.com/topics/steampipe-mod)) we would love you to join the community and start contributing.
+[Steampipe](https://steampipe.io) and [Powerpipe](https://powerpipe.io) are products produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). They are distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source).
 
-- **[Join #steampipe on Slack →](https://turbot.com/community/join)** and hang out with other Mod developers.
+## Get Involved
 
-Please see the [contribution guidelines](https://github.com/turbot/steampipe/blob/main/CONTRIBUTING.md) and our [code of conduct](https://github.com/turbot/steampipe/blob/main/CODE_OF_CONDUCT.md). All contributions are subject to the [Apache 2.0 open source license](https://github.com/turbot/steampipe-mod-aws-insights/blob/main/LICENSE).
+**[Join #powerpipe on Slack →](https://turbot.com/community/join)**
 
-Want to help but not sure where to start? Pick up one of the `help wanted` issues:
+Want to help but don't know where to start? Pick up one of the `help wanted` issues:
 
-- [Steampipe](https://github.com/turbot/steampipe/labels/help%20wanted)
+- [Powerpipe](https://github.com/turbot/powerpipe/labels/help%20wanted)
 - [AWS Insights Mod](https://github.com/turbot/steampipe-mod-aws-insights/labels/help%20wanted)
diff --git a/mod.sp b/mod.sp
@@ -1,15 +1,15 @@
 mod "aws_insights" {
-  # hub metadata
+  # Hub metadata
   title         = "AWS Insights"
-  description   = "Create dashboards and reports for your AWS resources using Steampipe."
+  description   = "Create dashboards and reports for your AWS resources using Powerpipe and Steampipe."
   color         = "#FF9900"
   documentation = file("./docs/index.md")
   icon          = "/images/mods/turbot/aws-insights.svg"
   categories    = ["aws", "dashboard", "public cloud"]
 
   opengraph {
-    title       = "Steampipe Mod for AWS Insights"
-    description = "Create dashboards and reports for your AWS resources using Steampipe."
+    title       = "Powerpipe Mod for AWS Insights"
+    description = "Create dashboards and reports for your AWS resources using Powerpipe and Steampipe."
     image       = "/images/mods/turbot/aws-insights-social-graphic.png"
   }