From bddbf1a825b2c108bd55b8cecf8e5f65956f49b8 Mon Sep 17 00:00:00 2001 From: AJ Emerich Date: Tue, 3 Feb 2026 15:06:54 +0100 Subject: [PATCH] docs(cloudquery): update descriptions --- .../cloudquery/AbstractCloudQueryCommand.java | 16 ++++++++++------ .../kestra/plugin/cloudquery/CloudQueryCLI.java | 6 ++++-- .../java/io/kestra/plugin/cloudquery/Sync.java | 16 ++++++++-------- 3 files changed, 22 insertions(+), 16 deletions(-) diff --git a/src/main/java/io/kestra/plugin/cloudquery/AbstractCloudQueryCommand.java b/src/main/java/io/kestra/plugin/cloudquery/AbstractCloudQueryCommand.java index 5b14766..2a21d41 100644 --- a/src/main/java/io/kestra/plugin/cloudquery/AbstractCloudQueryCommand.java +++ b/src/main/java/io/kestra/plugin/cloudquery/AbstractCloudQueryCommand.java @@ -23,22 +23,23 @@ abstract class AbstractCloudQueryCommand extends Task { protected static final String DEFAULT_IMAGE = "ghcr.io/cloudquery/cloudquery:latest"; @Schema( - title = "Additional environment variables for the CloudQuery process." + title = "Set CloudQuery environment variables", + description = "Key-value pairs rendered by Kestra and passed to the CloudQuery process; empty by default." ) protected Property> env; @Schema( - title = "Deprecated, use 'taskRunner' instead" + title = "Deprecated Docker runner options", + description = "Replaced by 'taskRunner'; keep only for legacy flows." ) @PluginProperty @Deprecated private DockerOptions docker; @Schema( - title = "The task runner to use.", + title = "Choose the task runner", description = """ - Task runners are provided by plugins, each have their own properties. - If you change from the default one, be careful to also configure the entrypoint to an empty list if needed.""" + Defaults to the Docker runner with an empty entrypoint. If you switch runners, ensure the entrypoint suits the CloudQuery binary.""" ) @PluginProperty @Builder.Default @@ -48,7 +49,10 @@ abstract class AbstractCloudQueryCommand extends Task { .entryPoint(Collections.emptyList()) .build(); - @Schema(title = "The task runner container image, only used if the task runner is container-based.") + @Schema( + title = "Container image for CloudQuery runner", + description = "Used when the selected task runner is container-based; defaults to ghcr.io/cloudquery/cloudquery:latest." + ) @Builder.Default private Property containerImage = Property.ofValue(DEFAULT_IMAGE); diff --git a/src/main/java/io/kestra/plugin/cloudquery/CloudQueryCLI.java b/src/main/java/io/kestra/plugin/cloudquery/CloudQueryCLI.java index 3f2fb8c..faa1212 100644 --- a/src/main/java/io/kestra/plugin/cloudquery/CloudQueryCLI.java +++ b/src/main/java/io/kestra/plugin/cloudquery/CloudQueryCLI.java @@ -30,7 +30,8 @@ @Getter @NoArgsConstructor @Schema( - title = "Execute a CloudQuery command from CLI." + title = "Run CloudQuery CLI commands", + description = "Executes provided CloudQuery CLI commands in order using /bin/sh -c inside the task runner container; honors rendered env vars and input files." ) @Plugin( examples = { @@ -80,7 +81,8 @@ public class CloudQueryCLI extends AbstractCloudQueryCommand implements RunnableTask, NamespaceFilesInterface, InputFilesInterface, OutputFilesInterface { @Schema( - title = "List of CloudQuery commands to run." + title = "Commands to execute", + description = "Shell commands executed sequentially; include the cloudquery binary (aliased to /app/cloudquery) and any arguments." ) @NotNull protected Property> commands; diff --git a/src/main/java/io/kestra/plugin/cloudquery/Sync.java b/src/main/java/io/kestra/plugin/cloudquery/Sync.java index 5bd5bce..d65711d 100644 --- a/src/main/java/io/kestra/plugin/cloudquery/Sync.java +++ b/src/main/java/io/kestra/plugin/cloudquery/Sync.java @@ -43,7 +43,8 @@ @Getter @NoArgsConstructor @Schema( - title = "Execute a CloudQuery sync." + title = "Run a CloudQuery sync", + description = "Renders CloudQuery configs to temp YAML files and runs `cloudquery sync`; can persist incremental state in Kestra KV and enables console logging by default." ) @Plugin( examples = { @@ -109,8 +110,8 @@ public class Sync extends AbstractCloudQueryCommand implements RunnableTask configs; @Schema( - title = "Whether to use Kestra's internal KV Store backend to save incremental index.", - description = "Kestra can automatically add a backend option to your sources and store the incremental indexes in the KV Store. " + - "Use this boolean to activate this option." + title = "Store incremental state in Kestra KV", + description = "When true (default false), adds CloudQuery backend_options and saves the SQLite state file to the namespace KV store for reuse." ) @Builder.Default private Property incremental = Property.ofValue(false); @@ -132,8 +132,8 @@ public class Sync extends AbstractCloudQueryCommand implements RunnableTask> outputFiles; @Schema( - title = "Enable console logging", - description = "Whether to enable verbose console logging from CloudQuery." + title = "Enable CloudQuery console logs", + description = "Adds the --log-console flag; enabled by default." ) @Builder.Default private Property logConsole = Property.ofValue(true);