Skip to content

docs(plugin-cloudquery): add how-to doc #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aj-emerich wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(plugin-cloudquery): add how-to doc #154

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/main/resources/doc/io.kestra.plugin.cloudquery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# How to use the CloudQuery plugin

Sync cloud infrastructure data across sources and destinations using CloudQuery from Kestra flows.

## Authentication

Pass credentials via the `env` map — at minimum set `CLOUDQUERY_API_KEY` (required to download CloudQuery plugins). Add provider-specific variables (e.g. `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `PG_CONNECTION_STRING`) for each source and destination. Store secrets in [secrets](https://kestra.io/docs/concepts/secret) and apply connection properties globally with [plugin defaults](https://kestra.io/docs/workflow-components/plugin-defaults).

## Tasks

`Sync` runs a CloudQuery sync from a set of source/destination configs — set `configs` (required, a list of CloudQuery source and destination configuration objects). Set `incremental: true` to persist state between runs (default `false`). The task runs in a container (default image `ghcr.io/cloudquery/cloudquery:latest-ubuntu`). Use `namespaceFiles` to reference [namespace files](https://kestra.io/docs/concepts/namespace-files), `inputFiles` to stage additional files, and `outputFiles` to retrieve results.

`CloudQueryCLI` runs arbitrary CloudQuery CLI commands — set `commands` (required). Use `beforeCommands`, `env`, `namespaceFiles`, `inputFiles`, and `outputFiles` the same way as `Sync`.
Loading