[PATCH] 623 Added pki-audit man page.
A new man page has been added for the pki <subsystem>-audit CLI. Due to database upgrade issue, the audit command itself has been removed from all subsystems except TPS. https://fedorahosted.org/pki/ticket/1437 -- Endi S. Dewata
On 06/30/15 22:18, Endi Sukma Dewata wrote:
A new man page has been added for the pki <subsystem>-audit CLI. Due to database upgrade issue, the audit command itself has been removed from all subsystems except TPS.
https://fedorahosted.org/pki/ticket/1437
_______________________________________________ Pki-devel mailing list Pki-devel@redhat.com https://www.redhat.com/mailman/listinfo/pki-devel Endi,
This was a little confusing as the ticket is for a kra-audit man page. I think I understand a bit better after reading comment #4, however, I still have the following questions/comments: * What is '<TPS admin authentication>', and how does one obtain this? * The 'pki tps-audit-mod --help' command shows the following: usage: tps-audit-mod [OPTIONS...] --action <action> Action: update (default), enable, disable. --help Show help options --input <file> Input file containing audit configuration. --output <file> Output file to store audit configuration. where the man page does not talk about the 'update (default)' switch for the '--action <action>' option. One or more EXAMPLES would be nice, although this will probably suffice for the first pass at a man page. -- Matt
Thanks for the comments. Please take a look at the updated patch. On 7/14/2015 12:17 PM, Matthew Harmsen wrote:
This was a little confusing as the ticket is for a kra-audit man page. I think I understand a bit better after reading comment #4,
Yes, the command is removed from all subsystems except TPS because of the database upgrade requirement.
however, I still have the following questions/comments:
* What is '<TPS admin authentication>', and how does one obtain this?
I added a reference to the Authentication section in pki(1) and an explanation that the user must be in the Administrators group.
* The 'pki tps-audit-mod --help' command shows the following:
usage: tps-audit-mod [OPTIONS...] --action <action> Action: update (default), enable, disable. --help Show help options --input <file> Input file containing audit configuration. --output <file> Output file to store audit configuration.
where the man page does not talk about the 'update (default)' switch for the '--action <action>' option.
One or more EXAMPLES would be nice, although this will probably suffice for the first pass at a man page.
To clarify this I created a separate description for each usage: * pki tps-audit-mod --action <action> * pki tps-audit-mod --input <file path> I removed the "update (default)" from the CLI since it can be confusing. -- Endi S. Dewata
On 7/15/2015 5:13 PM, Endi Sukma Dewata wrote:
Thanks for the comments. Please take a look at the updated patch.
On 7/14/2015 12:17 PM, Matthew Harmsen wrote:
This was a little confusing as the ticket is for a kra-audit man page. I think I understand a bit better after reading comment #4,
Yes, the command is removed from all subsystems except TPS because of the database upgrade requirement.
however, I still have the following questions/comments:
* What is '<TPS admin authentication>', and how does one obtain this?
I added a reference to the Authentication section in pki(1) and an explanation that the user must be in the Administrators group.
* The 'pki tps-audit-mod --help' command shows the following:
usage: tps-audit-mod [OPTIONS...] --action <action> Action: update (default), enable, disable. --help Show help options --input <file> Input file containing audit configuration. --output <file> Output file to store audit configuration.
where the man page does not talk about the 'update (default)' switch for the '--action <action>' option.
One or more EXAMPLES would be nice, although this will probably suffice for the first pass at a man page.
To clarify this I created a separate description for each usage: * pki tps-audit-mod --action <action> * pki tps-audit-mod --input <file path>
I removed the "update (default)" from the CLI since it can be confusing.
Please take a look at the new patch (#623-2). The patch now contains just the new pki-audit man page and line wrapping in the pki man page. The CLI changes to remove the non-working command from non-TPS subsystems have been posted as a separate patch (#636). -- Endi S. Dewata
1. perhaps instead of saying: Currently the only valid sub‐ system is tps. we say Currently the only supported sub‐ system is tps. 2.pki [CLI options] <subsystem>-audit This command is to list the available audit commands the subsystem. do you mean This command is to list the available audit commands *of* the subsystem ? 3.pki [CLI options] <subsystem>-audit-mod --action <action> [command options] This command is to the audit status in the subsystem. do you mean This command is to *modify* the audit status in the subsystem. ? also, what is the audit status? if its enable/disable status, how about: This command is to *modify* the audit system (enabled/disabled) status in the subsystem. ? 4. To enable/disable audit in TPS execute the following command: try with a punctuation To enable/disable audit in TPS*,* execute the following command: thanks, Christina On 07/17/2015 03:29 PM, Endi Sukma Dewata wrote:
On 7/15/2015 5:13 PM, Endi Sukma Dewata wrote:
Thanks for the comments. Please take a look at the updated patch.
On 7/14/2015 12:17 PM, Matthew Harmsen wrote:
This was a little confusing as the ticket is for a kra-audit man page. I think I understand a bit better after reading comment #4,
Yes, the command is removed from all subsystems except TPS because of the database upgrade requirement.
however, I still have the following questions/comments:
* What is '<TPS admin authentication>', and how does one obtain this?
I added a reference to the Authentication section in pki(1) and an explanation that the user must be in the Administrators group.
* The 'pki tps-audit-mod --help' command shows the following:
usage: tps-audit-mod [OPTIONS...] --action <action> Action: update (default), enable, disable. --help Show help options --input <file> Input file containing audit configuration. --output <file> Output file to store audit configuration.
where the man page does not talk about the 'update (default)' switch for the '--action <action>' option.
One or more EXAMPLES would be nice, although this will probably suffice for the first pass at a man page.
To clarify this I created a separate description for each usage: * pki tps-audit-mod --action <action> * pki tps-audit-mod --input <file path>
I removed the "update (default)" from the CLI since it can be confusing.
Please take a look at the new patch (#623-2). The patch now contains just the new pki-audit man page and line wrapping in the pki man page.
The CLI changes to remove the non-working command from non-TPS subsystems have been posted as a separate patch (#636).
On 7/17/2015 6:12 PM, Christina Fu wrote:
1. perhaps instead of saying: Currently the only valid sub‐ system is tps. we say Currently the only supported sub‐ system is tps.
Fixed.
2.pki [CLI options] <subsystem>-audit This command is to list the available audit commands the subsystem. do you mean This command is to list the available audit commands *of* the subsystem ?
Fixed. I used "for" to be consistent with other man pages.
3.pki [CLI options] <subsystem>-audit-mod --action <action> [command options] This command is to the audit status in the subsystem. do you mean This command is to *modify* the audit status in the subsystem. ?
Fixed. I meant to say "change".
also, what is the audit status? if its enable/disable status, how about: This command is to *modify* the audit system (enabled/disabled) status in the subsystem. ?
Fixed. Audit status is referring to the log.instance.SignedAudit.enable property in the CS.cfg.
4. To enable/disable audit in TPS execute the following command: try with a punctuation To enable/disable audit in TPS*,* execute the following command:
Fixed.
thanks, Christina
Conditionally ACKed by cfu. Pushed to master. -- Endi S. Dewata
participants (3)
-
Christina Fu -
Endi Sukma Dewata -
Matthew Harmsen