Merge pull request #1425

dird: deprecate client `Autoprune`, `JobRetention`, and `FileRetention`

CHANGELOG.md

@@ -41,6 +41,7 @@ and since Bareos version 20 this project adheres to [Semantic Versioning](https:
 - webui: add config resource graph to analytics (experimental) [PR #1412]
 - dird: keep copy and migration control/administrative jobs [PR #1421]
 - scripts: config-lib improve get_local_hostname fallback [PR #1402]
+- dird: deprecate client `Autoprune`, `JobRetention`, and `FileRetention` [PR #1425]
 
 ### Removed
 - remove no longer used pkglists [PR #1335]
@@ -121,6 +122,7 @@ and since Bareos version 20 this project adheres to [Semantic Versioning](https:
 [PR #1421]: https://github.com/bareos/bareos/pull/1421
 [PR #1422]: https://github.com/bareos/bareos/pull/1422
 [PR #1424]: https://github.com/bareos/bareos/pull/1424
+[PR #1425]: https://github.com/bareos/bareos/pull/1425
 [PR #1429]: https://github.com/bareos/bareos/pull/1429
 [PR #1439]: https://github.com/bareos/bareos/pull/1439
 [unreleased]: https://github.com/bareos/bareos/tree/master

core/src/dird/dird_conf.cc

@@ -242,10 +242,10 @@ static ResourceItem client_items[] = {
   { "SoftQuotaGracePeriod", CFG_TYPE_TIME, ITEM(res_client, SoftQuotaGracePeriod), 0, CFG_ITEM_DEFAULT, "0", NULL, NULL },
   { "StrictQuotas", CFG_TYPE_BOOL, ITEM(res_client, StrictQuotas), 0, CFG_ITEM_DEFAULT, "false", NULL, NULL },
   { "QuotaIncludeFailedJobs", CFG_TYPE_BOOL, ITEM(res_client, QuotaIncludeFailedJobs), 0, CFG_ITEM_DEFAULT, "true", NULL, NULL },
-  { "FileRetention", CFG_TYPE_TIME, ITEM(res_client, FileRetention), 0, CFG_ITEM_DEFAULT, "5184000" /* 60 days */, NULL, NULL },
-  { "JobRetention", CFG_TYPE_TIME, ITEM(res_client, JobRetention), 0, CFG_ITEM_DEFAULT, "15552000" /* 180 days */, NULL, NULL },
+  { "FileRetention", CFG_TYPE_TIME, ITEM(res_client, FileRetention), 0, CFG_ITEM_DEPRECATED | CFG_ITEM_DEFAULT, "5184000" /* 60 days */, NULL, NULL },
+  { "JobRetention", CFG_TYPE_TIME, ITEM(res_client, JobRetention), 0, CFG_ITEM_DEPRECATED | CFG_ITEM_DEFAULT, "15552000" /* 180 days */, NULL, NULL },
   { "HeartbeatInterval", CFG_TYPE_TIME, ITEM(res_client, heartbeat_interval), 0, CFG_ITEM_DEFAULT, "0", NULL, NULL },
-  { "AutoPrune", CFG_TYPE_BOOL, ITEM(res_client, AutoPrune), 0, CFG_ITEM_DEFAULT, "false", NULL, NULL },
+  { "AutoPrune", CFG_TYPE_BOOL, ITEM(res_client, AutoPrune), 0, CFG_ITEM_DEPRECATED | CFG_ITEM_DEFAULT, "false", NULL, NULL },
   { "MaximumConcurrentJobs", CFG_TYPE_PINT32, ITEM(res_client, MaxConcurrentJobs), 0, CFG_ITEM_DEFAULT, "1", NULL, NULL },
   { "MaximumBandwidthPerJob", CFG_TYPE_SPEED, ITEM(res_client, max_bandwidth), 0, 0, NULL, NULL, NULL },
   { "NdmpLogLevel", CFG_TYPE_PINT32, ITEM(res_client, ndmp_loglevel), 0, CFG_ITEM_DEFAULT, "4", NULL, NULL },

docs/manuals/source/TasksAndConcepts/VolumeManagement.rst

@@ -139,15 +139,7 @@ Automatic labeling discussed above brings up the problem of Volume management. W
 
 The tools Bareos gives you to help automatically manage these problems are the following:
 
--  :config:option:`dir/client/FileRetention`\ : catalog file record retention period.
-
--  :config:option:`dir/client/JobRetention`\ : catalog job record retention period.
-
--  :config:option:`dir/client/AutoPrune`\  = yes: permit the application of the above two retention periods.
-
--
-
-   :config:option:`dir/pool/VolumeRetention`\
+-  :config:option:`dir/pool/VolumeRetention`\
 
 -  :config:option:`dir/pool/AutoPrune`\  = yes: permit the application of the :config:option:`dir/pool/VolumeRetention`\  period.
 

docs/manuals/source/include/autogenerated/bareos-dir-config-schema.json

@@ -448,12 +448,14 @@
           "datatype": "TIME",
           "code": 0,
           "default_value": "5184000",
+          "deprecated": true,
           "equals": true
         },
         "JobRetention": {
           "datatype": "TIME",
           "code": 0,
           "default_value": "15552000",
+          "deprecated": true,
           "equals": true
         },
         "HeartbeatInterval": {
@@ -466,6 +468,7 @@
           "datatype": "BOOLEAN",
           "code": 0,
           "default_value": "false",
+          "deprecated": true,
           "equals": true
         },
         "MaximumConcurrentJobs": {

systemtests/tests/config-dump/etc/bareos/bareos-dir-19.2.7-show-verbose.conf.in

@@ -43,10 +43,7 @@ Client {
   # SoftQuotaGracePeriod = 0
   # StrictQuotas = no
   # QuotaIncludeFailedJobs = yes
-  # FileRetention = 2 months
-  # JobRetention = 6 months
   # HeartbeatInterval = 0
-  # AutoPrune = no
   # MaximumConcurrentJobs = 1
   # NdmpLogLevel = 4
   # NdmpBlockSize = 63 k

systemtests/tests/config-dump/etc/bareos/bareos-dir-full.conf.in

@@ -66,10 +66,7 @@ Client {
   # SoftQuotaGracePeriod = 0
   # StrictQuotas = No
   # QuotaIncludeFailedJobs = Yes
-  # FileRetention = 2 months
-  # JobRetention = 6 months
   # HeartbeatInterval = 0
-  # AutoPrune = No
   # MaximumConcurrentJobs = 1
   # MaximumBandwidthPerJob = 0
   # NdmpLogLevel = 4
@@ -110,10 +107,7 @@ Client {
   # SoftQuotaGracePeriod = 0
   # StrictQuotas = No
   # QuotaIncludeFailedJobs = Yes
-  # FileRetention = 2 months
-  # JobRetention = 6 months
   # HeartbeatInterval = 0
-  # AutoPrune = No
   # MaximumConcurrentJobs = 1
   # MaximumBandwidthPerJob = 0
   # NdmpLogLevel = 4

systemtests/tests/config-dump/etc/orig/bareos-dir-19.2.7-show-verbose.conf

@@ -45,10 +45,7 @@ Client {
   #  SoftQuotaGracePeriod = 0
   #  StrictQuotas = no
   #  QuotaIncludeFailedJobs = yes
-  #  FileRetention = 2 months
-  #  JobRetention = 6 months
   #  HeartbeatInterval = 0
-  #  AutoPrune = no
   #  MaximumConcurrentJobs = 1
   #  NdmpLogLevel = 4
   #  NdmpBlockSize = 63 k