From edebe925fff5e09035eec34e78b976a555fbca39 Mon Sep 17 00:00:00 2001 From: mbecker20 Date: Sun, 5 Oct 2025 14:50:20 -0700 Subject: [PATCH] add km maintenance tasks aliases --- client/core/rs/src/api/execute/alerter.rs | 3 ++- client/core/rs/src/api/execute/maintenance.rs | 6 +++--- client/core/rs/src/api/execute/mod.rs | 3 +++ 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/client/core/rs/src/api/execute/alerter.rs b/client/core/rs/src/api/execute/alerter.rs index fbcda74ec..298fa8cf6 100644 --- a/client/core/rs/src/api/execute/alerter.rs +++ b/client/core/rs/src/api/execute/alerter.rs @@ -30,7 +30,8 @@ pub struct TestAlerter { // -/// Send a custom alert message to configured Alerters. Response: [Update] +/// Send a custom alert message to configured Alerters. Response: [Update]. +/// Alias: `alert` #[typeshare] #[derive( Serialize, diff --git a/client/core/rs/src/api/execute/maintenance.rs b/client/core/rs/src/api/execute/maintenance.rs index 161993040..9ea00d6d0 100644 --- a/client/core/rs/src/api/execute/maintenance.rs +++ b/client/core/rs/src/api/execute/maintenance.rs @@ -29,7 +29,7 @@ pub struct ClearRepoCache {} // /// **Admin only.** Backs up the Komodo Core database to compressed jsonl files. -/// Response: [Update] +/// Response: [Update]. Aliases: `backup-database`, `backup-db`, `backup`. /// /// Mount a folder to `/backups`, and Core will use it to create /// timestamped database dumps, which can be restored using @@ -56,7 +56,7 @@ pub struct BackupCoreDatabase {} /// **Admin only.** Trigger a global poll for image updates on Stacks and Deployments /// with `poll_for_updates` or `auto_update` enabled. -/// Response: [Update] +/// Response: [Update]. Alias: `auto-update`. /// /// 1. `docker compose pull` any Stacks / Deployments with `poll_for_updates` or `auto_update` enabled. This will pick up any available updates. /// 2. Redeploy Stacks / Deployments that have updates found and 'auto_update' enabled. @@ -79,7 +79,7 @@ pub struct GlobalAutoUpdate {} // /// **Admin only.** Rotates all connected Server keys. -/// Response: [Update] +/// Response: [Update]. Alias: `rotate-keys`. #[typeshare] #[derive( Debug, diff --git a/client/core/rs/src/api/execute/mod.rs b/client/core/rs/src/api/execute/mod.rs index 6f07602aa..abef87452 100644 --- a/client/core/rs/src/api/execute/mod.rs +++ b/client/core/rs/src/api/execute/mod.rs @@ -161,8 +161,11 @@ pub enum Execution { // MAINTENANCE ClearRepoCache(ClearRepoCache), + #[clap(alias = "backup-database", alias = "backup-db", alias = "backup")] BackupCoreDatabase(BackupCoreDatabase), + #[clap(alias = "auto-update")] GlobalAutoUpdate(GlobalAutoUpdate), + #[clap(alias = "rotate-keys")] RotateAllServerKeys(RotateAllServerKeys), // SLEEP