From 4f8dde50b20662046931bd307d79fa77486ee5c4 Mon Sep 17 00:00:00 2001 From: Jon Udell Date: Tue, 12 Mar 2024 13:04:29 -0700 Subject: [PATCH 1/3] update-readme --- README.md | 81 +++++-------------------------------------------------- 1 file changed, 6 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index 1e667c3c..cee7f1d5 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Powerpipe is **dashboards and benchmarks as code**. Use it to visualize any data **Code, not clicks** - Our dashboards are [code](https://powerpipe.io/docs/powerpipe-hcl): version-controlled, composable, shareable, easy to edit — designed for the way you work. [Join](https://turbot.com/community/join) our open-source community! -## Demo Time! +## Demo time! **[Watch on YouTube →](https://www.youtube.com/watch?v=-h6RSpvR0FE)** @@ -37,88 +37,19 @@ brew tap turbot/tap brew install powerpipe ``` -## Your first dashboard +## Dashboards for DevOps -Dashboards use charts, tables, and interactive widgets to help you explore and visualize your resources. For example, the RNAcentrals mod visualizes a dataset of RNA types. To run the RNACentral dashboard: +See our documentation for DevOps-oriented examples of how to use Powerpipe to [visualize cloud infrastructure](https://powerpipe.io/docs#visualize-cloud-infrastructure) and [run security and compliance benchmarks](https://powerpipe.io/docs#run-security-and-compliance-benchmarks). These examples use [mods](https://hub.powerpipe.io/?engines=steampipe) written for [Steampipe and its plugin ecosystem](https://hub.steampipe.io/). -```sh -mkdir rna && cd rna -powerpipe mod install https://github.com/turbot/powerpipe-mod-rnacentral -powerpipe server --database postgres://reader:NWDMCE5xdipIjRrp@hh-pgsql-public.ebi.ac.uk:5432/pfmegrnargs -``` - -View your dashboard at http://localhost:9033 - -![rnacentral](./images/rnacentral.png) - -## Dashboards and Benchmarks with Steampipe - -Many Powerpipe [mods](https://hub.powerpipe.io.io/mods?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) includes **benchmarks** that check your cloud resources for compliance. The [Net Insights](https://hub.powerpipe.io/mods/turbot/net_insights?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) mod provides configuration, compliance and security controls to validate security best practices for DNS records. To run the [SSL/TLS Best Practices benchmark](https://hub.powerpipe.io/mods/turbot/net_insights/controls/benchmark.ssl_best_practices): - -```sh -# Net insights uses the net plugin from Steampipe -steampipe plugin install net -steampipe service start - -# Install the Powerpipe mod -mkdir net && cd net -powerpipe mod install https://github.com/turbot/powerpipe-mod-net-insights - -# Start the dashboard server -powerpipe server -``` - -View your dashboard at http://localhost:9033 - -![net insights dashboard](./images/net_insights_dashboard.png) - -You can run benchmarks as dashboards too! Here's the console ouput. - -```hcl -powerpipe benchmark run benchmark.ssl_certificate_best_practices --output=brief -``` - -![net insights console](./images/net_insights_console.png) - -## Developing - -
-Developing Powerpipe - -Prerequisites: - -- [Golang](https://golang.org/doc/install) Version 1.21 or higher. - -Clone `github.com/powerpipe` and `github.com/turbot/pipe-fittings` repositories: - -```sh -git clone https://github.com/turbot/powerpipe -git clone https://github.com/turbot/pipe-fittings -cd powerpipe -``` - -The build lands in `/usr/local/bin/` unless `OUTPUT_DIR` is specified. - -```sh -make -``` - -Check the version: -```sh -powerpipe --version -``` -``` -Powerpipe v0.1.0-local.1 -``` +Note, though, that Powerpipe is database-agnostic. We also provide samples for dashboards that use other data sources via [Postgres, SQLite, DuckDB, and MySQL](https://hub.powerpipe.io/?engines=postgres,duckdb,sqlite,mysql). -
-## Open Source & Contributing +## Open source & contributing This repository is published under the [AGPL 3.0](https://www.gnu.org/licenses/agpl-3.0.html) license. Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). Contributors must sign our [Contributor License Agreement](https://turbot.com/open-source#cla) as part of their first pull request. We look forward to collaborating with you! [Powerpipe](https://powerpipe.io) is a product produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). It is 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). -## Get Involved +## Get involved **[Join #powerpipe on Slack →](https://turbot.com/community/join)** From 4309a1c7ab8156c9a42c3a134eddc54e39002c8a Mon Sep 17 00:00:00 2001 From: Jon Udell Date: Tue, 12 Mar 2024 13:08:48 -0700 Subject: [PATCH 2/3] minor --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cee7f1d5..9ccd4949 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ brew install powerpipe ## Dashboards for DevOps -See our documentation for DevOps-oriented examples of how to use Powerpipe to [visualize cloud infrastructure](https://powerpipe.io/docs#visualize-cloud-infrastructure) and [run security and compliance benchmarks](https://powerpipe.io/docs#run-security-and-compliance-benchmarks). These examples use [mods](https://hub.powerpipe.io/?engines=steampipe) written for [Steampipe and its plugin ecosystem](https://hub.steampipe.io/). +See our documentation for examples of how to use Powerpipe to [visualize cloud infrastructure](https://powerpipe.io/docs#visualize-cloud-infrastructure) and [run security and compliance benchmarks](https://powerpipe.io/docs#run-security-and-compliance-benchmarks). These examples use [mods](https://hub.powerpipe.io/?engines=steampipe) written for [Steampipe and its plugin ecosystem](https://hub.steampipe.io/). Note, though, that Powerpipe is database-agnostic. We also provide samples for dashboards that use other data sources via [Postgres, SQLite, DuckDB, and MySQL](https://hub.powerpipe.io/?engines=postgres,duckdb,sqlite,mysql). From 3f7d31222865b3a2331207d2f1dd74b8178dc27a Mon Sep 17 00:00:00 2001 From: Jon Udell Date: Tue, 12 Mar 2024 13:11:29 -0700 Subject: [PATCH 3/3] minor --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9ccd4949..773649c6 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ brew install powerpipe ## Dashboards for DevOps -See our documentation for examples of how to use Powerpipe to [visualize cloud infrastructure](https://powerpipe.io/docs#visualize-cloud-infrastructure) and [run security and compliance benchmarks](https://powerpipe.io/docs#run-security-and-compliance-benchmarks). These examples use [mods](https://hub.powerpipe.io/?engines=steampipe) written for [Steampipe and its plugin ecosystem](https://hub.steampipe.io/). +See our documentation for examples of how to use Powerpipe to [visualize cloud infrastructure](https://powerpipe.io/docs#visualize-cloud-infrastructure) and [run security and compliance benchmarks](https://powerpipe.io/docs#run-security-and-compliance-benchmarks). These examples use [mods](https://hub.powerpipe.io/?engines=steampipe) written for Steampipe and its plugin ecosystem. Note, though, that Powerpipe is database-agnostic. We also provide samples for dashboards that use other data sources via [Postgres, SQLite, DuckDB, and MySQL](https://hub.powerpipe.io/?engines=postgres,duckdb,sqlite,mysql).