feat: add nodes

Author: Mahanmmi

.github/workflows/build.yaml.txt .github/workflows/build.yaml.github/workflows/build.yaml.txt renamed to .github/workflows/build.yaml

@@ -43,17 +43,17 @@ jobs:
             ${{ runner.os }}-go-${{ hashFiles('**/go.mod') }}-
             ${{ runner.os }}-go-
 
-      - name: Build Template Plugin App
+      - name: Build Kubernetes Plugin App
         working-directory: ./cloudql
         run: make build
-      - name: Pack Template Plugin Build
+      - name: Pack Kubernetes Plugin Build
         working-directory: ./cloudql
         run: |
           tar -cvf build.tar build
-      - name: Upload Template Plugin Artifact
+      - name: Upload Kubernetes Plugin Artifact
         uses: actions/[email protected]
         with:
-          name: steampipe-plugin-template
+          name: steampipe-plugin-kubernetes
           path: ./cloudql/build.tar
           retention-days: 1
       - name: Build Local Describer App
@@ -66,7 +66,7 @@ jobs:
       - name: Upload Local Artifact
         uses: actions/[email protected]
         with:
-          name: local-og-describer-template
+          name: local-og-describer-kubernetes
           path: ./discovery/local.tar
           retention-days: 1
       - name: Add Tag to Release
@@ -82,25 +82,25 @@ jobs:
         run: make build
       - name: Create output directory
         working-directory: .
-        run: mkdir -p template-plugin
+        run: mkdir -p kubernetes-plugin
       - name: Copy steampipe plugin to output directory
         working-directory: .
-        run: cp ./cloudql/build/steampipe-plugin-template.plugin ./template-plugin/cloudql-plugin
+        run: cp ./cloudql/build/steampipe-plugin-kubernetes.plugin ./kubernetes-plugin/cloudql-plugin
       - name: Copy integration plugin to output directory
         working-directory: .
-        run: cp ./platform/build/integration-plugin ./template-plugin/
+        run: cp ./platform/build/integration-plugin ./kubernetes-plugin/
       - name: Copy manifest to output directory
         working-directory: .
-        run: cp ./platform/constants/manifest.yaml ./template-plugin/
+        run: cp ./platform/constants/manifest.yaml ./kubernetes-plugin/
       - name: Pack output
         working-directory: .
         run: |
-          tar -czf template-plugin.tar template-plugin
-      - name: Upload template outputs artifact
+          tar -czf kubernetes-plugin.tar kubernetes-plugin
+      - name: Upload kubernetes outputs artifact
         uses: actions/[email protected]
         with:
-          name: template-plugins
-          path: ./template-plugin.tar
+          name: kubernetes-plugins
+          path: ./kubernetes-plugin.tar
           retention-days: 1
 
       - name: Set Latest Tag Output
@@ -111,7 +111,7 @@ jobs:
           else
             echo "latest_tag=${{ steps.tag_version.outputs.new_tag }}" >> "$GITHUB_OUTPUT"
           fi
-  deploy-template-plugin:
+  deploy-kubernetes-plugin:
     needs: build
     runs-on: ubuntu-latest
     permissions:
@@ -121,12 +121,12 @@ jobs:
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4
-      - name: Download Template Plugin Artifact
+      - name: Download Kubernetes Plugin Artifact
         uses: actions/download-artifact@v4
         with:
-          name: steampipe-plugin-template
+          name: steampipe-plugin-kubernetes
           path: .
-      - name: Unpack Template Plugin Artifact
+      - name: Unpack Kubernetes Plugin Artifact
         run: |
           tar -xvf build.tar
       - name: Log in to Container Registry
@@ -135,13 +135,13 @@ jobs:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GHCR_PAT }}
-      - name: Build and Push Docker Image for Template Plugin
+      - name: Build and Push Docker Image for Kubernetes Plugin
         uses: docker/build-push-action@v4
         with:
           push: true
           tags: |
-            ghcr.io/${{ github.repository_owner }}/steampipe-plugin-template:0.0.1
-            ghcr.io/${{ github.repository_owner }}/steampipe-plugin-template:${{ needs.build.outputs.latest_tag }}
+            ghcr.io/${{ github.repository_owner }}/steampipe-plugin-kubernetes:0.0.1
+            ghcr.io/${{ github.repository_owner }}/steampipe-plugin-kubernetes:${{ needs.build.outputs.latest_tag }}
           file: cloudql/docker/Dockerfile
           context: .
   deploy-local-describer:
@@ -158,7 +158,7 @@ jobs:
       - name: Download Local Describer Artifact
         uses: actions/download-artifact@v4
         with:
-          name: local-og-describer-template
+          name: local-og-describer-kubernetes
           path: .
       - name: Unpack Local Describer Artifact
         run: |
@@ -174,8 +174,8 @@ jobs:
         with:
           push: true
           tags: |
-            ghcr.io/${{ github.repository_owner }}/og-describer-template:local-latest
-            ghcr.io/${{ github.repository_owner }}/og-describer-template:local-${{ needs.build.outputs.latest_tag }}
+            ghcr.io/${{ github.repository_owner }}/og-describer-kubernetes:local-latest
+            ghcr.io/${{ github.repository_owner }}/og-describer-kubernetes:local-${{ needs.build.outputs.latest_tag }}
           file: discovery/DockerFile
           context: .
   release-integration-plugin:
@@ -192,16 +192,16 @@ jobs:
       - name: Download Integration Plugin Artifact
         uses: actions/download-artifact@v4
         with:
-          name: template-plugins
+          name: kubernetes-plugins
       - name: Unpack Integration Plugin Artifact
         run: |
-          tar -xvf template-plugin.tar
+          tar -xvf kubernetes-plugin.tar
       - name: Pack folder content into a zip file for release
         run: |
-          cd template-plugin
-          zip -r template-plugin.zip .
+          cd kubernetes-plugin
+          zip -r kubernetes-plugin.zip .
       - name: Release Integration Plugin
         uses: softprops/action-gh-release@v2
         with:
-          files: ./template-plugin/template-plugin.zip
+          files: ./kubernetes-plugin/kubernetes-plugin.zip
           tag_name: ${{ needs.build.outputs.latest_tag }}

README.md

@@ -57,7 +57,7 @@ Fill the Integration information of the Provider in the [configs.go](./global/co
 const (
 IntegrationTypeLower = "template"                                    // example: aws, azure
 IntegrationName      = integration.Type("template,github")          // example: aws_account, github_account
-OGPluginRepoURL      = "github.com/opengovern/og-describer-template" // example: github.com/opengovern/og-describer-aws
+OGPluginRepoURL      = "github.com/opengovern/og-describer-kubernetes" // example: github.com/opengovern/og-describer-aws
 )
 ```
 
@@ -173,11 +173,11 @@ result will be saved in the output.json file.
 
 You can connect the describer to steampipe. For this, you should implement the steampipe plugin.
 
-You can use the [example plugin](./cloudql/template) as a reference. Example is for describing CohereAI datasets resource.
+You can use the [example plugin](./cloudql/kubernetes) as a reference. Example is for describing CohereAI datasets resource.
 
 ### 7.1 Add Table for the resource
 
-Add a file with this format: `table_template_resource.go` in the [plugin folder](./cloudql/template).
+Add a file with this format: `table_template_resource.go` in the [plugin folder](./cloudql/kubernetes).
 You Should implement the table definition for the resource. [Example file](./cloudql/template/table_template_artifact_dockerfile.go) is for describing CohereAI datasets resource.
 
 **Note:** Transform Field should have `Description.` prefix.
@@ -210,6 +210,6 @@ Also there is an example for write a UI spec for digitalocean in the [example](h
 
 ## 9 Test Plugins
 
-Change the [build.yaml.txt](.github/workflows/build.yaml.txt) to `build.yaml` and change the names of the plugins in the file.
+Change the [build.yaml.txt](.github/workflows/build.yaml) to `build.yaml` and change the names of the plugins in the file.
 
 Then you can test the plugins with runing action on the github.

cloudql/Makefile

@@ -2,7 +2,7 @@ STEAMPIPE_INSTALL_DIR ?= ~/.steampipe
 BUILD_TAGS = netgo
 
 build:
-	GOPRIVATE="github.com/opengovern" CC=/usr/bin/musl-gcc GOOS=linux GOARCH=amd64 go build -v -mod=mod -ldflags "-linkmode external -extldflags '-static' -s -w" -o ./build/steampipe-plugin-template.plugin *.go
+	GOPRIVATE="github.com/opengovern" CC=/usr/bin/musl-gcc GOOS=linux GOARCH=amd64 go build -v -mod=mod -ldflags "-linkmode external -extldflags '-static' -s -w" -o ./build/steampipe-plugin-kubernetes.plugin *.go
 
 install:
-	go build -o $(STEAMPIPE_INSTALL_DIR)/plugins/hub.steampipe.io/plugins/turbot/template@latest/steampipe-plugin-template.plugin -tags "${BUILD_TAGS}" *.go
+	go build -o $(STEAMPIPE_INSTALL_DIR)/plugins/hub.steampipe.io/plugins/turbot/kubernetes@latest/steampipe-plugin-kubernetes.plugin -tags "${BUILD_TAGS}" *.go

cloudql/docker/Dockerfile

@@ -1,3 +1,3 @@
 FROM alpine:latest
 
-COPY ../build/steampipe-plugin-template.plugin /steampipe-plugin-template.plugin
+COPY ../build/steampipe-plugin-kubernetes.plugin /steampipe-plugin-kubernetes.plugin

cloudql/kubernetes/common_column.go

@@ -0,0 +1,74 @@
+package kubernetes
+
+import (
+	"context"
+	"encoding/json"
+
+	"github.com/turbot/steampipe-plugin-sdk/v5/grpc/proto"
+	"github.com/turbot/steampipe-plugin-sdk/v5/plugin"
+	"github.com/turbot/steampipe-plugin-sdk/v5/plugin/transform"
+)
+
+const (
+	ColumnDescriptionTitle = "Title of the resource."
+	ColumnDescriptionAkas  = "Array of globally unique identifier strings (also known as) for the resource."
+	ColumnDescriptionTags  = "A map of tags for the resource. This includes both labels and annotations."
+)
+
+func objectMetadataColumns() []*plugin.Column {
+	return []*plugin.Column{
+		{Name: "name", Type: proto.ColumnType_STRING, Transform: transform.FromField("Description.MetaObject.Name"), Description: "Name of the object.  Name must be unique within a namespace."},
+		{Name: "namespace", Type: proto.ColumnType_STRING, Transform: transform.FromField("Description.MetaObject.Namespace"), Description: "Namespace defines the space within which each name must be unique."},
+		{Name: "uid", Type: proto.ColumnType_STRING, Description: "UID is the unique in time and space value for this object.", Transform: transform.FromField("Description.MetaObject.UID").Transform(transform.NullIfZeroValue)},
+		{Name: "generate_name", Type: proto.ColumnType_STRING, Transform: transform.FromField("Description.MetaObject.GenerateName"), Description: "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided."},
+		{Name: "resource_version", Type: proto.ColumnType_STRING, Transform: transform.FromField("Description.MetaObject.ResourceVersion"), Description: "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed."},
+		{Name: "generation", Type: proto.ColumnType_INT, Transform: transform.FromField("Description.MetaObject.Generation"), Description: "A sequence number representing a specific generation of the desired state."},
+		{Name: "creation_timestamp", Type: proto.ColumnType_TIMESTAMP, Transform: transform.FromField("Description.MetaObject.CreationTimestamp").Transform(v1TimeToRFC3339), Description: "CreationTimestamp is a timestamp representing the server time when this object was created."},
+		{Name: "deletion_timestamp", Type: proto.ColumnType_TIMESTAMP, Transform: transform.FromField("Description.MetaObject.DeletionTimestamp").Transform(v1TimeToRFC3339), Description: "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted."},
+		{Name: "deletion_grace_period_seconds", Type: proto.ColumnType_INT, Transform: transform.FromField("Description.MetaObject.DeletionGracePeriodSeconds"), Description: "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system.  Only set when deletionTimestamp is also set."},
+		{Name: "labels", Type: proto.ColumnType_JSON, Transform: transform.FromField("Description.MetaObject.Labels"), Description: "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services."},
+		{Name: "annotations", Type: proto.ColumnType_JSON, Transform: transform.FromField("Description.MetaObject.Annotations"), Description: "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata."},
+		{Name: "owner_references", Type: proto.ColumnType_JSON, Transform: transform.FromField("Description.MetaObject.OwnerReferences"), Description: "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."},
+		{Name: "finalizers", Type: proto.ColumnType_JSON, Transform: transform.FromField("Description.MetaObject.Finalizers"), Description: "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed."},
+	}
+}
+
+func commonColumns(c []*plugin.Column) []*plugin.Column {
+	res := objectMetadataColumns()
+	res = append(res, c...)
+	res = append(res, []*plugin.Column{
+		{
+			Name:        "platform_integration_id",
+			Type:        proto.ColumnType_STRING,
+			Description: "The Platform Integration ID in which the resource is located.",
+			Transform:   transform.FromField("IntegrationID"),
+		},
+		{
+			Name:        "platform_resource_id",
+			Type:        proto.ColumnType_STRING,
+			Description: "The unique ID of the resource in opengovernance.",
+			Transform:   transform.FromField("PlatformID"),
+		},
+		{
+			Name:        "platform_metadata",
+			Type:        proto.ColumnType_JSON,
+			Description: "The metadata of the resource",
+			Transform:   transform.FromField("Metadata").Transform(marshalJSON),
+		},
+		{
+			Name:        "platform_resource_description",
+			Type:        proto.ColumnType_JSON,
+			Description: "The full model description of the resource",
+			Transform:   transform.FromField("Description").Transform(marshalJSON),
+		},
+	}...)
+	return res
+}
+
+func marshalJSON(_ context.Context, d *transform.TransformData) (interface{}, error) {
+	b, err := json.Marshal(d.Value)
+	if err != nil {
+		return nil, err
+	}
+	return string(b), nil
+}

cloudql/template/errors.go cloudql/kubernetes/errors.gocloudql/template/errors.go renamed to cloudql/kubernetes/errors.go

@@ -1,4 +1,4 @@
-package template
+package kubernetes
 
 import (
 	"context"
@@ -60,17 +60,3 @@ func retryConfig() *plugin.RetryConfig {
 		CappedDuration:       30000,
 	}
 }
-
-// function which returns an ErrorPredicate for GitHub API calls
-func isNotFoundError(notFoundErrors []string) plugin.ErrorPredicate {
-	return func(err error) bool {
-		if err != nil {
-			for _, item := range notFoundErrors {
-				if strings.Contains(err.Error(), item) {
-					return true
-				}
-			}
-		}
-		return false
-	}
-}

cloudql/template/plugin.go cloudql/kubernetes/plugin.gocloudql/template/plugin.go renamed to cloudql/kubernetes/plugin.go

@@ -1,4 +1,4 @@
-package template
+package kubernetes
 
 import (
 	"context"
@@ -19,8 +19,7 @@ func Plugin(ctx context.Context) *plugin.Plugin {
 		},
 		DefaultTransform: transform.FromCamel(),
 		TableMap: map[string]*plugin.Table{
-			
-			"github_artifact_dockerfile": tableGitHubArtifactDockerFile(),
+			"kubernetes_node": tableKubernetesNode(),
 		},
 	}
 	for key, table := range p.TableMap {