public/freeipa
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Update pruning design with implement enable/disable options

Browse Source 
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 <rcritten@redhat.com>
Reviewed-By: Mohammad Rizwan <myusuf@redhat.com>
Reviewed-By: Florence Blanc-Renaud <flo@redhat.com>
This commit is contained in:
Rob Crittenden authored and Florence Blanc-Renaud committed 2023-02-20 10:43:17 +01:00
1 parent 6a809ff58f
commit 50d40b5a9f
1 file changed
+4 -4
Download Patch File Download Diff File Expand all files Collapse all files
doc/designs/expired_certificate_pruning.md
+4 -4
View File
@@ -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 |