Skip to content

Commit 855b1f8

Browse files
committed
formatting and wording
Found some things that somehow got reverted back to a previous file state. Removed carriage returns after param descriptions and before valid options. Fixed wording in type and provider descriptions. Refactored some sentences to start with better action verbs. Fixed some things to present tense. Removed a backslash for markdown formatting.
1 parent 35f58ba commit 855b1f8

File tree

1 file changed

+12
-21
lines changed

1 file changed

+12
-21
lines changed

README.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The java_ks module uses a combination of keytool and openssl to manage entries i
1818

1919
##Module Description
2020

21-
The java\_ks module contains a type called `java_ks` and a single provider named `keytool`. Their purpose is to enable importation of arbitrary, already generated and signed certificates into a Java keystore for use by various applications.
21+
The java_ks module contains a type called `java_ks` and a single provider named `keytool`. Their purpose is to enable importation of arbitrary, already generated and signed certificates into a Java keystore for use by various applications.
2222

2323
##Setup
2424

@@ -73,52 +73,43 @@ broker.ks keystore with the alias of broker.example.com.
7373
##Reference
7474

7575
###Public Types
76-
* `java_ks`: This resource manages the entries in a Java keystore, and uses composite namevars to accomplish the same alias spread across multiple target keystores.
76+
* `java_ks`: This resource manages the entries in a Java keystore, and uses composite namevars to allow the same alias across multiple target keystores.
7777

7878
###Public Providers
79-
* `keytool`: Uses a combination of the binaries `openssl` and `keytool` to manage Java keystores
79+
* `keytool`: Manages Java keystores by using a combination of the `openssl` and `keytool` commands.
8080

8181
####Parameters
8282
All parameters, except where specified, are optional.
8383

8484
#####`certificate`
85-
*Required.* Places an already-signed certificate in the keystore. This will autorequire the specified file and must be present on the node before java_ks{} is run.
86-
Valid options: string. Default: undef.
85+
*Required.* Places an already-signed certificate in the keystore. This autorequires the specified file and must be present on the node before java_ks{} is run. Valid options: string. Default: undef.
8786

8887
#####`chain`
89-
Bundles intermediary certificate authorities with certificate authorities. This autorequires the file of the same path and must be present on the node before java_ks{} is run.
90-
Valid options: string. Default: undef.
88+
Bundles intermediary certificate authorities with certificate authorities. This autorequires the file of the same path and must be present on the node before java_ks{} is run. Valid options: string. Default: undef.
9189

9290
#####`ensure`
9391
Valid options: absent, present, latest. Latest verifies md5 certificate fingerprints for the stored certificate and the source file. Default: present.
9492

9593
#####`name`
96-
*Required.* Identifies the entry in the keystore. This will be converted to lowercase.
97-
Valid options: string. Default: undef.
94+
*Required.* Identifies the entry in the keystore. This will be converted to lowercase. Valid options: string. Default: undef.
9895

9996
#####`password`
100-
Used to protect the keystore. If private keys are also protected, this password will be used to attempt to unlock them.
101-
Valid options: String. Must be 6 or more characters. This cannot be used together with `password_file`, but *you must pass at least one of these parameters.* Default: undef.
97+
This password is used to protect the keystore. If private keys are also protected, this password will be used to attempt to unlock them. Valid options: String. Must be 6 or more characters. This cannot be used together with `password_file`, but *you must pass at least one of these parameters.* Default: undef.
10298

10399
#####`password_file`
104-
A plaintext file where the password is stored. Used as an alternative to `password`. This cannot be used together with `password`, but *you must pass at least one of these parameters.*
105-
Valid options: String to the plaintext file. Default: undef.
100+
Sets a plaintext file where the password is stored. Used as an alternative to `password`. This cannot be used together with `password`, but *you must pass at least one of these parameters.* Valid options: String to the plaintext file. Default: undef.
106101

107102
#####`path`
108-
Used for command (keytool, openssl) execution.
109-
Valid options: array or file path separated list (for example : in linux). Default: undef.
103+
Used for command (keytool, openssl) execution. Valid options: array or file path separated list (for example : in linux). Default: undef.
110104

111105
#####`private_key`
112-
A private key that encrypts traffic to a server application. Must be accompanied by a signed certificate for the keytool provider. This will autorequire the specified file and must be present on the node before java_ks{} is run.
113-
Valid options: string. Default: undef.
106+
Sets a private key that encrypts traffic to a server application. Must be accompanied by a signed certificate for the keytool provider. This autorequires the specified file and must be present on the node before java_ks{} is run. Valid options: string. Default: undef.
114107

115108
#####`target`
116-
*Required.* Destination file for the keystore. Autorequires the parent directory of the file.
117-
Valid options: string. Default: undef.
109+
*Required.* Specifies a destination file for the keystore. Autorequires the parent directory of the file. Valid options: string. Default: undef.
118110

119111
#####`trustcacerts`
120-
Certificate authorities input into a keystore aren’t trusted by default, so if you are adding a CA you need to set this parameter to true.
121-
Valid options: 'true' or 'false'. Default: 'false'
112+
Certificate authorities input into a keystore aren’t trusted by default, so if you are adding a CA you need to set this parameter to 'true'. Valid options: 'true' or 'false'. Default: 'false'.
122113

123114

124115
Limitations

0 commit comments

Comments
 (0)