Re: [PATCH proxmox v2 1/6] fix #7904: Add 'enable' to {sync,verify,tape,gc} job schema and datastore config

[Christian Ebner <c.ebner@proxmox.com>]

On 10/7/26 3:45 PM, Jonas Theisen wrote:
> To be able to en-/disable the respective jobs this patch adds the
> enable field to the job config and the needed schema.

We do already have the `disable` field for prune jobs, so IMHO it is 
preferable to introduce the same fields and logic for the other jobs as 
well. This would allow to keep config and logic consistent.

So rather define:
```
pub const DISABLE_JOB_SCHEMA: Schema = BooleanSchema::new(
     "Disable the scheduled execution of this task.",
  )
  .default(false)
  .schema();
```

And use that for all, including GC and prune job config.


Avoiding serialization of default values as suggested by Maximiliano [0] 
would be preferable as well, especially to reduce config bloating with 
default values.


[0] https://lore.proxmox.com/pbs-devel/s8old88mxnt.fsf@toolbox/

> This also adds the gc_enable parameter to the datastore config
> to allow this type of job to be disabled.
> 
> Signed-off-by: Jonas Theisen <j.theisen@proxmox.com>
> ---
>   pbs-api-types/src/datastore.rs | 12 ++++++++++++
>   pbs-api-types/src/jobs.rs      | 24 ++++++++++++++++++++++++
>   2 files changed, 36 insertions(+)
> 
> diff --git a/pbs-api-types/src/datastore.rs b/pbs-api-types/src/datastore.rs
> index 93ccaf07..50658b58 100644
> --- a/pbs-api-types/src/datastore.rs
> +++ b/pbs-api-types/src/datastore.rs
> @@ -460,6 +460,11 @@ pub const COUNTER_RESET_SCHEDULE_SCHEMA: Schema =
>               optional: true,
>               schema: SINGLE_LINE_COMMENT_SCHEMA,
>           },
> +        "gc-enable": {
> +            description: "Enable scheduled execution of garbage collection.",
> +            optional: true,
> +            type: bool,

nit: It would be preferable to reuse the common schema definition for 
this case as well.

> +        },
>           "gc-schedule": {
>               optional: true,
>               schema: GC_SCHEDULE_SCHEMA,
> @@ -524,6 +529,9 @@ pub struct DataStoreConfig {
>       #[serde(skip_serializing_if = "Option::is_none")]
>       pub comment: Option<String>,
>   
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub gc_enable: Option<bool>,
> +
>       #[serde(skip_serializing_if = "Option::is_none")]
>       pub gc_schedule: Option<String>,
>   
> @@ -605,6 +613,7 @@ impl DataStoreConfig {
>               name,
>               path,
>               comment: None,
> +            gc_enable: None,
>               gc_schedule: None,
>               gc_on_unmount: None,
>               prune_schedule: None,
> @@ -1704,6 +1713,9 @@ pub struct GarbageCollectionJobStatus {
>       pub store: String,
>       #[serde(flatten)]
>       pub status: GarbageCollectionStatus,
> +    /// Scheduled execution of the gc job
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub enable: Option<bool>,
>       /// Schedule of the gc job
>       #[serde(skip_serializing_if = "Option::is_none")]
>       pub schedule: Option<String>,
> diff --git a/pbs-api-types/src/jobs.rs b/pbs-api-types/src/jobs.rs
> index 9a5d2b77..0ae93678 100644
> --- a/pbs-api-types/src/jobs.rs
> +++ b/pbs-api-types/src/jobs.rs
> @@ -62,6 +62,12 @@ pub const VERIFICATION_SCHEDULE_SCHEMA: Schema =
>           .type_text("<calendar-event>")
>           .schema();
>   
> +pub const ENABLE_JOB_SCHEMA: Schema = BooleanSchema::new(
> +    "Enables the scheduled execution of this task.",
> +)
> +.default(true)
> +.schema();
> +
>   pub const REMOVE_VANISHED_BACKUPS_SCHEMA: Schema = BooleanSchema::new(
>       "Delete vanished backups. This removes the local copy if the remote backup was deleted.",
>   )
> @@ -228,6 +234,10 @@ pub const VERIFICATION_OUTDATED_AFTER_SCHEMA: Schema =
>               optional: true,
>               schema: VERIFICATION_SCHEDULE_SCHEMA,
>           },
> +        enable: {
> +            optional: true,
> +            schema: ENABLE_JOB_SCHEMA,
> +        },
>           ns: {
>               optional: true,
>               schema: BACKUP_NAMESPACE_SCHEMA,
> @@ -268,6 +278,8 @@ pub struct VerificationJobConfig {
>       /// when to schedule this job in calendar event notation
>       pub schedule: Option<String>,
>       #[serde(skip_serializing_if = "Option::is_none", default)]
> +    pub enable: Option<bool>,
> +    #[serde(skip_serializing_if = "Option::is_none")]
>       /// on which backup namespace to run the verification recursively
>       pub ns: Option<BackupNamespace>,
>       #[serde(skip_serializing_if = "Option::is_none", default)]
> @@ -403,6 +415,10 @@ pub struct TapeBackupJobSetup {
>               optional: true,
>               schema: SYNC_SCHEDULE_SCHEMA,
>           },
> +        enable: {
> +            optional: true,
> +            schema: ENABLE_JOB_SCHEMA,
> +        },
>       }
>   )]
>   #[derive(Serialize, Deserialize, Clone, Updater, PartialEq)]
> @@ -417,6 +433,8 @@ pub struct TapeBackupJobConfig {
>       pub comment: Option<String>,
>       #[serde(skip_serializing_if = "Option::is_none")]
>       pub schedule: Option<String>,
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub enable: Option<bool>,
>   }
>   
>   #[api(
> @@ -642,6 +660,10 @@ pub const UNMOUNT_ON_SYNC_DONE_SCHEMA: Schema =
>               optional: true,
>               schema: SYNC_SCHEDULE_SCHEMA,
>           },
> +        enable: {
> +            optional: true,
> +            schema: ENABLE_JOB_SCHEMA,
> +        },
>           "group-filter": {
>               schema: GROUP_FILTER_LIST_SCHEMA,
>               optional: true,
> @@ -718,6 +740,8 @@ pub struct SyncJobConfig {
>       #[serde(skip_serializing_if = "Option::is_none")]
>       pub schedule: Option<String>,
>       #[serde(skip_serializing_if = "Option::is_none")]
> +    pub enable: Option<bool>,
> +    #[serde(skip_serializing_if = "Option::is_none")]
>       pub group_filter: Option<Vec<GroupFilter>>,
>       #[serde(flatten)]
>       pub limit: RateLimitConfig,