Add description, validation_message, and introduced fields into openssl resources #6855
Conversation
tas50
force-pushed
the
openssl_fix
branch
2 times, most recently
from
a438648 to
653cba8
Compare
|
|
||
| property :private_key_content, | ||
| String, | ||
| description: "The content of the private key including new lines. Used if you don't want to write a private key to disk first then use `private_key_path`" |
There was a problem hiding this comment.
The second sentence has got a bit mangled here.
If you have a private key on disk already, use
private_key_path
maybe?
| property :owner, [String, nil] | ||
| property :group, [String, nil] | ||
| property :mode, [Integer, String], default: "0640" | ||
| description "A resource for generating rsa public key files given a rsa private key" |
There was a problem hiding this comment.
RSA is an acronym and should be capitalised across the board.
| Integer, | ||
| equal_to: [1024, 2048, 4096, 8192], | ||
| validation_message: "key_length must be 1024, 2048, 4096, or 8192", | ||
| description: "The desired Bit Length of the generated key", |
There was a problem hiding this comment.
Bit Length should not be capitalised.
| property :mode, [Integer, String], default: "0600" | ||
| property :force, [true, false], default: false | ||
| introduced "14.0" | ||
| description "A resource for generating rsa private key files. If a valid rsa key"\ |
There was a problem hiding this comment.
RSA should be capitalised.
lib/chef/resource/openssl_dhparam.rb
Outdated
| Integer, | ||
| equal_to: [1024, 2048, 4096, 8192], | ||
| validation_message: "key_length must be 1024, 2048, 4096, or 8192", | ||
| description: "The desired Bit Length of the generated key", |
There was a problem hiding this comment.
Bit Length should not be capitalised.
|
|
||
| property :private_key_path, | ||
| String, | ||
| description: "The path to the private key to generate the public key from" |
There was a problem hiding this comment.
Just "The path to the private key" is fine here - the resource has already documented that it's generating a public key.
|
|
||
| property :path, | ||
| String, | ||
| description: "The optional path to write the file to if you'd like to specify it here instead of in the resource name", |
There was a problem hiding this comment.
We need to come up with less torturous wording for name properties.
|
I fixed up a few of them a bit |
tas50
force-pushed
the
openssl_fix
branch
2 times, most recently
from
02cefc8 to
99f7338
Compare
…sl resources This follows the pattern used on docs.chef.io right now. We may change it later, but this will get us autogenerated docs for now. Signed-off-by: Tim Smith <tsmith@chef.io>
|
This thread has been automatically locked because it has not had recent activity. Please open a new issue for related bugs and link to relevant comments in this thread. |
Get these updated for the latest and greatest before we ship Chef 14
Signed-off-by: Tim Smith tsmith@chef.io