Steampipe-sync

[j7m4]

Summary

steampipe may be used as a resource-provider for a myriad of cloud services. This first pass will target resources from: aws, azure, gcp, github, and tfe (Terraform Cloud).

Usage Tutorial

This tutorial assumes familiarity with steampipe. This tutorial may also serve as a usage flow if steampipe is configured with some plugins and connections.

Listing Providers

All Providers

Initially, ctrlplane will not have any registered resource providers. ctrlc can show you all possible resource provider connections by looking at your steampipe configurations. Since no id will be present in the response, you can infer that no resource provider connections are registered.

ctrlc sync steampipe list --all

id                                      connection-name     connection-type    resource-type
--------------------------------------------------------------------------------------------
                                        *                   aws                eks_cluster
                                        *                   aws                vpc
                                        *                   gcp                kubernetes_cluster
                                        *                   kubernetes         namespace
                                        *                   kubernetes         pod
                                        *                   kubernetes         job
...
                                        dev                 kubernetes         namespace
...
                                        cluster_dev1        kubernetes         namespace
...
                                        cluster_dev2        kubernetes         namespace
...

Registered providers

By default ctrlc sync steampipe list will show only those provider connections that are registered.

ctrlc sync steampipe list

REGISTERED 

id                                      connection-name   connection-type   resource-type
--------------------------------------------------------------------------------------

a4af36d1-e571-4024-98fd-9394ab2d37a1    *                 aws                eks_cluster
cf908056-8dcd-4537-ad63-0c2c066098c4    dev               kubernetes         namespace
4f511fac-23a1-4983-a293-cafc50aeef24    sandbox           gcp                kubernetes_cluster

In the above the id refers to the resource provider id in ctrlplane. For each of the registered resource provider connections above, ctrlplane expects to receive resources from steampipe.

The connection-name, connection-type and resource-type refer to steampipe configurations.

The connection-type is a short name mapping to plugins defined in steampipe hub. Supported connection-types linked to their plugins:

• aws
• azure
• gcp
• github
• kubernetes
• tfe

The connection-name maps to the connection in steampipe. It will work with both plugin or aggregator connections (see steampipe docs). However, we also provide an * alias to refer to all connections for a plugin as an added convenience.

The resource-type maps to the steampipe table with it's prefix removed. In the example above:

• for connection-type kubernetes and resource-type namespace, it maps to steampipe table kubernetes_namespace.
• for connection-type aws and resource-type eks_cluster, it maps to steampipe table aws_eks_cluster.
• for connection-type gcp and resource-type kubernetes-cluster, it maps to steampipe table gcp_kubernetes_cluster.

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.