Merge pull request #61 from turbot/release/v0.7

Release/v0.7
turbot · Mar 6, 2024 · 91c5d24 · 91c5d24
2 parents 17a7a10 + a57a17b
commit 91c5d24
Show file tree

Hide file tree

Showing 18 changed files with 101 additions and 73 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -13,6 +13,9 @@ A clear and concise description of what the bug is.
 **Steampipe version (`steampipe -v`)**
 Example: v0.3.0
 
+**Powerpipe version (`powerpipe -v`)**
+Example: v0.3.0
+
 **Plugin version (`steampipe plugin list`)**
 Example: v0.5.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.7 [2024-03-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.6 [2024-02-15]
 
 _Bug fixes_

diff --git a/README.md b/README.md
@@ -1,4 +1,9 @@
-# Kubernetes Insights Mod for Steampipe
+# Kubernetes 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.
 
 A Kubernetes dashboarding tool that can be used to view dashboards and reports across all of your Kubernetes clusters.
 
@@ -16,57 +21,65 @@ Dashboards can help answer questions like:
 
 Dashboards are available for 10+ resources, including Clusters, DaemonSets, Deployments, Nodes, Pods, Services, and more. Dashboards are also available for RBAC security controls, where you can check the assigned permissions to different resources.
 
-## Getting started
+## Documentation
+
+- **[Dashboards →](https://hub.powerpipe.io/mods/turbot/kubernetes_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 Kubernetes plugin with [Steampipe](https://steampipe.io):
+This mod also requires [Steampipe](https://steampipe.io) with the [Kubernetes plugin](https://hub.steampipe.io/plugins/turbot/kubernetes) as the data source. Install Steampipe (https://steampipe.io/downloads), or use Brew:
 
 ```sh
+brew install turbot/tap/steampipe
 steampipe plugin install kubernetes
 ```
 
-Clone this repo:
+Steampipe will automatically use your default Kubernetes credentials. Optionally, you can [setup multiple context connections](https://hub.steampipe.io/plugins/turbot/kubernetes#multiple-context-connections) or [customize Kubernetes credentials](https://hub.steampipe.io/plugins/turbot/kubernetes#configuring-kubernetes-cluster-credentials).
+
+Finally, install the mod:
 
 ```sh
-git clone https://github.com/turbot/steampipe-mod-kubernetes-insights.git
-cd steampipe-mod-kubernetes-insights
+mkdir dashboards
+cd dashboards
+powerpipe mod init
+powerpipe mod install github.com/turbot/steampipe-mod-kubernetes-insights
 ```
 
-### Usage
+### Browsing Dashboards
 
-Start your dashboard server to get started:
+Start Steampipe as the data source:
 
 ```sh
-steampipe dashboard
+steampipe service start
 ```
 
-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.
+Start the dashboard server:
 
-### Credentials
-
-This mod uses the credentials configured in the [Steampipe Kubernetes plugin](https://hub.steampipe.io/plugins/turbot/kubernetes).
+```sh
+powerpipe server
+```
 
-### 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 reports, 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-kubernetes-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)
-- [Kubernetes Insights Mod](https://github.com/turbot/steampipe-mod-kubernetes-insights/labels/help%20wanted)
+- [Powerpipe](https://github.com/turbot/powerpipe/labels/help%20wanted)
+- [Kubernetes Insights Mod](https://github.com/turbot/steampipe-mod-kubernetes-insights/labels/help%20wanted)
diff --git a/dashboards/clusterrole/cluster_role_base.sp b/dashboards/clusterrole/cluster_role_base.sp
@@ -1,7 +1,7 @@
 graph "cluster_role_resource_structure" {
   param "cluster_role_uids" {}
 
-  node "user" {
+  node "user_cluster_role" {
     category = category.user
 
     sql = <<-EOQ
@@ -25,7 +25,7 @@ graph "cluster_role_resource_structure" {
     args = [param.cluster_role_uids]
   }
 
-  node "group" {
+  node "group_cluster_role" {
     category = category.group
 
     sql = <<-EOQ

diff --git a/dashboards/rbac/rbac_base.sp b/dashboards/rbac/rbac_base.sp
@@ -73,7 +73,7 @@ graph "rbac_resource_structure" {
     args = [param.role_binding_uids]
   }
 
-  node "user" {
+  node "user_rbac" {
     category = category.user
 
     sql = <<-EOQ
@@ -113,7 +113,7 @@ graph "rbac_resource_structure" {
     args = [param.rbac_role_uids]
   }
 
-  node "group" {
+  node "group_rbac" {
     category = category.group
 
     sql = <<-EOQ

diff --git a/dashboards/role/role_base.sp b/dashboards/role/role_base.sp
@@ -1,7 +1,7 @@
 graph "role_resource_structure" {
   param "role_uids" {}
 
-  node "user" {
+  node "user_role" {
     category = category.user
 
     sql = <<-EOQ
@@ -25,7 +25,7 @@ graph "role_resource_structure" {
     args = [param.role_uids]
   }
 
-  node "group" {
+  node "group_role" {
     category = category.group
 
     sql = <<-EOQ

diff --git a/docs/images/kubernetes_cluster_dashboard.png b/docs/images/kubernetes_cluster_dashboard.png
diff --git a/docs/images/kubernetes_cluster_role_detail.png b/docs/images/kubernetes_cluster_role_detail.png
diff --git a/docs/images/kubernetes_container_dashboard.png b/docs/images/kubernetes_container_dashboard.png
diff --git a/docs/images/kubernetes_daemonset_age_report.png b/docs/images/kubernetes_daemonset_age_report.png
diff --git a/docs/images/kubernetes_deployment_detail.png b/docs/images/kubernetes_deployment_detail.png
diff --git a/docs/images/kubernetes_namespace_detail.png b/docs/images/kubernetes_namespace_detail.png
diff --git a/docs/images/kubernetes_node_detail.png b/docs/images/kubernetes_node_detail.png
diff --git a/docs/images/kubernetes_pod_detail.png b/docs/images/kubernetes_pod_detail.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,3 @@
----
-repository: "https://github.com/turbot/steampipe-mod-kubernetes-insights"
----
-
 # Kubernetes Insights Mod
 
 Create dashboards and reports for your Kubernetes resources using Steampipe.
@@ -27,69 +23,65 @@ Dashboards can help answer questions like:
 
 Dashboards are available for 10+ resources, including Clusters, DaemonSets, Deployments, Nodes, Pods, Services, and more. Dashboards are also available for RBAC security controls, where you can check the assigned permissions to different resources.
 
-## References
-
-[Kubernetes](https://kubernetes.io/) also known as K8s, is an open-source system for automating deployment, scaling, and management of containerized applications.
-
-[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 the current configuration of your cloud resources against the desired configuration, and `dashboards` that organize and display key pieces of information.
-
 ## Documentation
 
-- **[Dashboards →](https://hub.steampipe.io/mods/turbot/kubernetes_insights/dashboards)**
+- **[Dashboards →](https://hub.powerpipe.io/mods/turbot/kubernetes_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 Kubernetes plugin with [Steampipe](https://steampipe.io):
+This mod also requires [Steampipe](https://steampipe.io) with the [Kubernetes plugin](https://hub.steampipe.io/plugins/turbot/kubernetes) as the data source. Install Steampipe (https://steampipe.io/downloads), or use Brew:
 
 ```sh
+brew install turbot/tap/steampipe
 steampipe plugin install kubernetes
 ```
 
-Clone:
+Steampipe will automatically use your default Kubernetes credentials. Optionally, you can [setup multiple context connections](https://hub.steampipe.io/plugins/turbot/kubernetes#multiple-context-connections) or [customize Kubernetes credentials](https://hub.steampipe.io/plugins/turbot/kubernetes#configuring-kubernetes-cluster-credentials).
+
+Finally, install the mod:
 
 ```sh
-git clone https://github.com/turbot/steampipe-mod-kubernetes-insights.git
-cd steampipe-mod-kubernetes-insights
+mkdir dashboards
+cd dashboards
+powerpipe mod init
+powerpipe mod install github.com/turbot/steampipe-mod-kubernetes-insights
 ```
 
-### Usage
+### Browsing Dashboards
 
-Start your dashboard server to get started:
+Start Steampipe as the data source:
 
-```shell
-steampipe dashboard
+```sh
+steampipe service start
 ```
 
-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
+Start the dashboard server:
 
-This mod uses the credentials configured in the [Steampipe Kubernetes plugin](https://hub.steampipe.io/plugins/turbot/kubernetes).
+```sh
+powerpipe server
+```
 
-### 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 reports, 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-kubernetes-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)
-- [Kubernetes Insights Mod](https://github.com/turbot/steampipe-mod-kubernetes-insights/labels/help%20wanted)
+- [Powerpipe](https://github.com/turbot/powerpipe/labels/help%20wanted)
+- [Kubernetes Insights Mod](https://github.com/turbot/steampipe-mod-kubernetes-insights/labels/help%20wanted)
diff --git a/mod.sp b/mod.sp
@@ -1,15 +1,15 @@
 mod "kubernetes_insights" {
-  # hub metadata
+  # Hub metadata
   title         = "Kubernetes Insights"
-  description   = "Create dashboards and reports for your Kubernetes resources using Steampipe."
+  description   = "Create dashboards and reports for your Kubernetes resources using Powerpipe and Steampipe."
   color         = "#0089D6"
   documentation = file("./docs/index.md")
   icon          = "/images/mods/turbot/kubernetes-insights.svg"
   categories    = ["kubernetes", "dashboard", "public cloud"]
 
   opengraph {
-    title       = "Steampipe Mod for Kubernetes Insights"
-    description = "Create dashboards and reports for your Kubernetes resources using Steampipe."
+    title       = "Powerpipe Mod for Kubernetes Insights"
+    description = "Create dashboards and reports for your Kubernetes resources using Powerpipe and Steampipe."
     image       = "/images/mods/turbot/kubernetes-insights-social-graphic.png"
   }