Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -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<Map<String, String>> 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
Expand All @@ -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<String> containerImage = Property.ofValue(DEFAULT_IMAGE);

Expand Down
6 changes: 4 additions & 2 deletions src/main/java/io/kestra/plugin/cloudquery/CloudQueryCLI.java
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down Expand Up @@ -80,7 +81,8 @@
public class CloudQueryCLI extends AbstractCloudQueryCommand implements RunnableTask<ScriptOutput>, 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<List<String>> commands;
Expand Down
16 changes: 8 additions & 8 deletions src/main/java/io/kestra/plugin/cloudquery/Sync.java
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down Expand Up @@ -109,18 +110,17 @@ public class Sync extends AbstractCloudQueryCommand implements RunnableTask<Scri
private static final String CLOUD_QUERY_STATE = "CloudQueryState";

@Schema(
title = "CloudQuery configurations.",
description = "A list of CloudQuery configurations or files containing CloudQuery configurations.",
title = "CloudQuery sync configurations",
description = "Inline configs or file/URI paths rendered by Kestra and written to temporary YAML files passed to `cloudquery sync`.",
anyOf = { String.class, List.class, Map.class }
)
@PluginProperty
@NotNull
private List<Object> 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<Boolean> incremental = Property.ofValue(false);
Expand All @@ -132,8 +132,8 @@ public class Sync extends AbstractCloudQueryCommand implements RunnableTask<Scri
private Property<List<String>> 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<Boolean> logConsole = Property.ofValue(true);
Expand Down
Loading