diff --git a/specs/commandline/certificate.md b/specs/commandline/certificate.md index aaa43d078..bbb052625 100644 --- a/specs/commandline/certificate.md +++ b/specs/commandline/certificate.md @@ -208,7 +208,17 @@ A prompt is showed asking user to confirm the deletion. Upon successful deletion notation certificate delete --type --store ``` -A prompt is showed asking user to confirm the deletion. Upon successful deletion, the specific certificate is deleted in trust store named `` of type ``. If deletion fails, an error message with specific reasons is printed out. +A prompt is displayed, asking the user to confirm the deletion. Upon successful deletion, the specific certificate is deleted from the trust store named `` of type ``. The output message is printed out as following: + +```text +Successfully deleted from the trust store. +``` + +If users execute the deletion without specifying required flags using `notation cert delete `, the deletion fails and the error output message is printed out as follows: + +```text +Error: required flag(s) "store", "type" not set +``` ### Generate a local RSA key and a corresponding self-generated certificate for testing purpose and add the certificate into trust store diff --git a/specs/commandline/key.md b/specs/commandline/key.md index 020f190d3..bc5b64a64 100644 --- a/specs/commandline/key.md +++ b/specs/commandline/key.md @@ -2,7 +2,7 @@ ## Description -Use ```notation key``` command to manage keys used for signing. User can add/update/list/remove key to/from signing key list. Please be noted this command doesn't manage the lifecycle of signing key itself, it manages the signing key list only. +Use ```notation key``` command to manage keys used for signing. User can add/update/list/remove key to/from Notation signing key list. Please be noted this command doesn't manage the lifecycle of signing key itself, it manages the Notation signing key list only. ## Outline @@ -15,10 +15,10 @@ Usage: notation key [command] Available Commands: - add Add key to signing key list - delete Delete key from signing key list + add Add key to Notation signing key list + delete Remove key from Notation signing key list list List keys used for signing - update Update key in signing key list + update Update key in Notation signing key list Flags: -h, --help help for key @@ -27,7 +27,7 @@ Flags: ### notation key add ```text -Add key to signing key list +Add key to Notation signing key list Usage: notation key add --plugin [flags] @@ -45,7 +45,7 @@ Flags: ### notation key delete ```text -Delete key from signing key list +Remove key from Notation signing key list Usage: notation key delete [flags] ... @@ -74,7 +74,7 @@ Flags: ### notation key update ```text -Update key in signing key list +Update key in Notation signing key list Usage: notation key update [flags] @@ -115,10 +115,33 @@ notation key list Upon successful execution, a list of keys is printed out with information of name, key path, certificate path, key id and plugin name. The default signing key name is preceded by an asterisk. The key id and plugin name are used together to provide the information of the key identifier for the remote key and the plugin associated with it. -### Delete two keys from signing key list +### Remove a specified key from Notation signing key list + +```shell +notation key delete +``` + +- Upon successful removal of a local testing key created by notation, the output message is printed out as follows: + +```text +Removed from Notation signing key list. The source key still exists. +``` +- Upon successful removal of a key associated with a KMS, the output message is printed out as follows: + +```text +Removed from Notation signing key list. The source key still exists. +``` + +### Remove two keys from Notation signing key list ```shell notation key delete ``` -Upon successful execution, the names of deleted signing keys are printed out. Please be noted if default signing key is deleted, Notation will not automatically assign a new default signing key. User needs to update the default signing key explicitly. +Upon successful execution, the output message is printed out as follows. Please be noted if default signing key is removed, Notation will not automatically assign a new default signing key. User needs to update the default signing key explicitly. + +```text +Removed the following keys from Notation signing key list. The source keys still exist. + + +``` \ No newline at end of file