From 50d40b5a9f65f8ff85aa7d7875f59ea3380f678c Mon Sep 17 00:00:00 2001 From: Rob Crittenden Date: Tue, 7 Feb 2023 10:37:10 -0500 Subject: [PATCH] doc: Update pruning design with implement enable/disable options MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Instead of passing TRUE/FALSE to a single --enable option use two flags instead, which IMHO is clearer. So --enable=TRUE to --enable and --enable=FALSE to --disable Fixes: https://pagure.io/freeipa/issue/9323 Signed-off-by: Rob Crittenden Reviewed-By: Mohammad Rizwan Reviewed-By: Florence Blanc-Renaud --- doc/designs/expired_certificate_pruning.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/designs/expired_certificate_pruning.md b/doc/designs/expired_certificate_pruning.md index 35ead7b00..8947f67f8 100644 --- a/doc/designs/expired_certificate_pruning.md +++ b/doc/designs/expired_certificate_pruning.md @@ -105,7 +105,7 @@ A new verb will be added, pruning, to be used for enabling and configuring pruni ### Enabling pruning -`# ipa-acme-manage pruning --enable=TRUE` +`# ipa-acme-manage pruning --enable` Enabling the job will call @@ -139,7 +139,7 @@ No validation of setting February 31st will be done. That will be left to PKI. B ### Disabling pruning -`# ipa-acme-manage pruning --enable=FALSE` +`# ipa-acme-manage pruning --disable` This will remove the configuration option for `jobsScheduler.job.pruning.cron` just to be sure it no longer runs. @@ -236,8 +236,8 @@ Overview of the CLI commands. Example: | Command | Options | | --- | ----- | -| ipa-acme-manage pruning | --enable=TRUE | -| ipa-acme-manage pruning | --enable=FALSE | +| ipa-acme-manage pruning | --enable | +| ipa-acme-manage pruning | --disable | | ipa-acme-manage pruning | --cron=`"0 0 1 * *"` | | ipa-acme-manage pruning | --certretention=30 --certretentionunit=day | | ipa-acme-manage pruning | --certsearchsizelimit=1000 --certsearchtimelimit=0 |