feat(enterprise): implement job scheduler commands (#162) (#289)

* feat(enterprise): implement job scheduler commands (#162)

- Add Get command to retrieve job scheduler configuration
- Add Update command to modify job scheduler settings
- Support stdin input with '-' flag for JSON data
- Successfully tested against Docker compose environment

* docs(enterprise): add documentation for job scheduler commands

Author: joshrotenberg

crates/redisctl/src/cli.rs

@@ -995,6 +995,10 @@ pub enum EnterpriseCommands {
     #[command(subcommand)]
     Crdb(EnterpriseCrdbCommands),
 
+    /// Job scheduler operations
+    #[command(subcommand, name = "job-scheduler")]
+    JobScheduler(crate::commands::enterprise::job_scheduler::JobSchedulerCommands),
+
     /// Log operations
     #[command(subcommand)]
     Logs(crate::commands::enterprise::logs::LogsCommands),

crates/redisctl/src/commands/enterprise/job_scheduler.rs

@@ -0,0 +1,80 @@
+use anyhow::Context;
+use clap::Subcommand;
+
+use crate::cli::OutputFormat;
+use crate::connection::ConnectionManager;
+use crate::error::Result as CliResult;
+
+#[derive(Debug, Clone, Subcommand)]
+pub enum JobSchedulerCommands {
+    /// Get job scheduler configuration/settings
+    Get,
+
+    /// Update job scheduler settings
+    Update {
+        /// JSON data for configuration update (use @filename or - for stdin)
+        #[arg(short, long)]
+        data: String,
+    },
+}
+
+impl JobSchedulerCommands {
+    #[allow(dead_code)]
+    pub async fn execute(
+        &self,
+        conn_mgr: &ConnectionManager,
+        profile_name: Option<&str>,
+        output_format: OutputFormat,
+        query: Option<&str>,
+    ) -> CliResult<()> {
+        let client = conn_mgr.create_enterprise_client(profile_name).await?;
+
+        match self {
+            JobSchedulerCommands::Get => {
+                // Get job scheduler configuration/settings
+                let response: serde_json::Value = client
+                    .get("/v1/job_scheduler")
+                    .await
+                    .context("Failed to get job scheduler settings")?;
+
+                let output_data = if let Some(q) = query {
+                    super::utils::apply_jmespath(&response, q)?
+                } else {
+                    response
+                };
+                super::utils::print_formatted_output(output_data, output_format)?;
+            }
+
+            JobSchedulerCommands::Update { data } => {
+                let json_data = super::utils::read_json_data(data)?;
+
+                let response: serde_json::Value = client
+                    .put("/v1/job_scheduler", &json_data)
+                    .await
+                    .context("Failed to update job scheduler settings")?;
+
+                let output_data = if let Some(q) = query {
+                    super::utils::apply_jmespath(&response, q)?
+                } else {
+                    response
+                };
+                super::utils::print_formatted_output(output_data, output_format)?;
+            }
+        }
+
+        Ok(())
+    }
+}
+
+#[allow(dead_code)]
+pub async fn handle_job_scheduler_command(
+    conn_mgr: &ConnectionManager,
+    profile_name: Option<&str>,
+    job_scheduler_cmd: JobSchedulerCommands,
+    output_format: OutputFormat,
+    query: Option<&str>,
+) -> CliResult<()> {
+    job_scheduler_cmd
+        .execute(conn_mgr, profile_name, output_format, query)
+        .await
+}

crates/redisctl/src/commands/enterprise/mod.rs

@@ -6,6 +6,7 @@ pub mod crdb;
 pub mod crdb_impl;
 pub mod database;
 pub mod database_impl;
+pub mod job_scheduler;
 pub mod logs;
 pub mod logs_impl;
 pub mod module;

crates/redisctl/src/commands/enterprise/utils.rs

@@ -92,12 +92,22 @@ pub fn confirm_action(message: &str) -> CliResult<bool> {
     }
 }
 
-/// Read JSON data from string or file
+/// Read JSON data from string, file, or stdin
 pub fn read_json_data(data: &str) -> CliResult<Value> {
-    let json_str = if let Some(file_path) = data.strip_prefix('@') {
+    let json_str = if data == "-" {
+        // Read from stdin
+        use std::io::Read;
+        let mut buffer = String::new();
+        std::io::stdin()
+            .read_to_string(&mut buffer)
+            .map_err(|e| anyhow::anyhow!("Failed to read from stdin: {}", e))?;
+        buffer
+    } else if let Some(file_path) = data.strip_prefix('@') {
+        // Read from file
         std::fs::read_to_string(file_path)
             .map_err(|e| anyhow::anyhow!("Failed to read file {}: {}", file_path, e))?
     } else {
+        // Direct JSON string
         data.to_string()
     };
 

crates/redisctl/src/main.rs

@@ -244,6 +244,16 @@ async fn execute_enterprise_command(
             )
             .await
         }
+        JobScheduler(job_scheduler_cmd) => {
+            commands::enterprise::job_scheduler::handle_job_scheduler_command(
+                conn_mgr,
+                profile,
+                job_scheduler_cmd.clone(),
+                output,
+                query,
+            )
+            .await
+        }
         Logs(logs_cmd) => {
             commands::enterprise::logs_impl::handle_logs_commands(
                 conn_mgr, profile, logs_cmd, output, query,

docs/src/SUMMARY.md

@@ -35,6 +35,9 @@
 - [Modules](./enterprise/modules.md)
 - [Logs](./enterprise/logs.md)
 - [Active-Active (CRDB)](./enterprise/crdb.md)
+- [Actions (Tasks)](./enterprise/actions.md)
+- [Diagnostics](./enterprise/diagnostics.md)
+- [Job Scheduler](./enterprise/job-scheduler.md)
 - [Workflows](./enterprise/workflows.md)
 - [Raw API Access](./enterprise/api-access.md)
 

docs/src/enterprise/actions.md

@@ -0,0 +1,172 @@
+# Actions (Async Tasks)
+
+Actions in Redis Enterprise represent asynchronous operations or tasks that are running or have completed. The action commands allow you to monitor and manage these background operations.
+
+## Overview
+
+Many Redis Enterprise operations are asynchronous, returning an action ID that can be used to track progress. Actions include database creation/deletion, backup operations, imports/exports, and cluster maintenance tasks.
+
+## Available Commands
+
+### List All Actions
+
+List all actions in the cluster with optional filtering:
+
+```bash
+# List all actions
+redisctl enterprise action list
+
+# Filter by status
+redisctl enterprise action list --status completed
+redisctl enterprise action list --status running
+
+# Filter by type
+redisctl enterprise action list --type bdb_backup
+
+# Combine filters
+redisctl enterprise action list --status running --type bdb_import
+
+# Output as table
+redisctl enterprise action list -o table
+```
+
+### Get Action Details
+
+Get detailed information about a specific action:
+
+```bash
+# Get action by UID
+redisctl enterprise action get <action_uid>
+
+# Get action with specific fields using JMESPath
+redisctl enterprise action get <action_uid> -q "status"
+```
+
+### Check Action Status
+
+Quick status check for an action (returns just the status field):
+
+```bash
+redisctl enterprise action status <action_uid>
+```
+
+### Cancel Running Action
+
+Cancel a running action:
+
+```bash
+redisctl enterprise action cancel <action_uid>
+```
+
+### List Actions for Database
+
+List all actions for a specific database:
+
+```bash
+redisctl enterprise action list-for-bdb <bdb_uid>
+
+# Filter by status for specific database
+redisctl enterprise action list-for-bdb <bdb_uid> --status running
+```
+
+## Action Types
+
+Common action types you'll encounter:
+
+- `bdb_create` - Database creation
+- `bdb_delete` - Database deletion
+- `bdb_update` - Database configuration update
+- `bdb_backup` - Database backup operation
+- `bdb_import` - Database import operation
+- `bdb_export` - Database export operation
+- `crdb_create` - Active-Active database creation
+- `node_join` - Node joining cluster
+- `cluster_recovery` - Cluster recovery operation
+
+## Action Statuses
+
+Actions can have the following statuses:
+
+- `queued` - Action is queued for execution
+- `running` - Action is currently executing
+- `completed` - Action completed successfully
+- `failed` - Action failed with errors
+- `canceled` - Action was canceled
+
+## Examples
+
+### Monitor Database Creation
+
+```bash
+# Create a database (returns action_uid)
+ACTION_UID=$(redisctl enterprise database create --data @db.json -q "action_uid")
+
+# Check status
+redisctl enterprise action status $ACTION_UID
+
+# Get full details when complete
+redisctl enterprise action get $ACTION_UID
+```
+
+### List Recent Failed Actions
+
+```bash
+# List failed actions in table format
+redisctl enterprise action list --status failed -o table
+
+# Get details of a failed action
+redisctl enterprise action get <failed_action_uid> -q "{error: error_message, started: start_time}"
+```
+
+### Cancel Long-Running Import
+
+```bash
+# List running imports
+redisctl enterprise action list --status running --type bdb_import
+
+# Cancel specific import
+redisctl enterprise action cancel <import_action_uid>
+```
+
+### Monitor All Database Actions
+
+```bash
+# Watch all actions for a database
+watch -n 5 "redisctl enterprise action list-for-bdb 1 -o table"
+```
+
+## Integration with Async Operations
+
+The action commands work seamlessly with the `--wait` flag available on create/update/delete operations:
+
+```bash
+# This uses action monitoring internally
+redisctl enterprise database create --data @db.json --wait
+
+# Equivalent to manually monitoring:
+ACTION_UID=$(redisctl enterprise database create --data @db.json -q "action_uid")
+while [ "$(redisctl enterprise action status $ACTION_UID)" = "running" ]; do
+  sleep 5
+done
+```
+
+## API Versions
+
+The action commands support both v1 and v2 API endpoints:
+- v2 endpoints (`/v2/actions`) are preferred when available
+- v1 endpoints (`/v1/actions`) are used as fallback
+- Both return the same data structure
+
+## Best Practices
+
+1. **Always check action status** for async operations before proceeding
+2. **Use filtering** to reduce output when listing many actions
+3. **Save action UIDs** from create/update operations for tracking
+4. **Set up monitoring** for critical long-running actions
+5. **Check failed actions** for error details to diagnose issues
+
+## Related Commands
+
+- [`enterprise database`](./databases.md) - Database operations that create actions
+- [`enterprise cluster`](./cluster.md) - Cluster operations that create actions
+- [`enterprise crdb`](./crdb.md) - Active-Active operations that create actions