summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith84@gmail.com>2020-09-15 20:31:49 -0700
committerTim Smith <tsmith84@gmail.com>2020-09-15 20:31:49 -0700
commitfcb5b56f8bd89b9321e6d53568ad4baf4792d3ff (patch)
treefdcb8864418c2ea3e74b186015bb4b377816b343
parent8060a480d841234beae68fdd0b4c1ccab9bcd16a (diff)
downloadchef-fcb5b56f8bd89b9321e6d53568ad4baf4792d3ff.tar.gz
Improve openssl_x509_request descriptions and remove default
default_action is not needed here Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/resource/openssl_x509_request.rb30
1 files changed, 14 insertions, 16 deletions
diff --git a/lib/chef/resource/openssl_x509_request.rb b/lib/chef/resource/openssl_x509_request.rb
index 8ebf6fe8eb..760c1c970d 100644
--- a/lib/chef/resource/openssl_x509_request.rb
+++ b/lib/chef/resource/openssl_x509_request.rb
@@ -31,7 +31,7 @@ class Chef
description "Use the **openssl_x509_request** resource to generate PEM-formatted x509 certificates requests. If no existing key is specified, the resource will automatically generate a passwordless key with the certificate."
introduced "14.4"
examples <<~DOC
- Generate new ec key and csr file
+ **Generate new ec key and csr file**
```ruby
openssl_x509_request '/etc/ssl_files/my_ec_request.csr' do
@@ -42,7 +42,7 @@ class Chef
end
```
- Generate a new csr file from an existing ec key
+ **Generate a new csr file from an existing ec key**
```ruby
openssl_x509_request '/etc/ssl_files/my_ec_request2.csr' do
@@ -54,7 +54,7 @@ class Chef
end
```
- Generate new rsa key and csr file
+ **Generate new rsa key and csr file**
```ruby
openssl_x509_request '/etc/ssl_files/my_rsa_request.csr' do
@@ -80,46 +80,44 @@ class Chef
description: "The permission mode applied to all files created by the resource."
property :country, String,
- description: "Value for the C certificate field."
+ description: "Value for the `C` certificate field."
property :state, String,
- description: "Value for the ST certificate field."
+ description: "Value for the `ST` certificate field."
property :city, String,
- description: "Value for the L certificate field."
+ description: "Value for the `L` certificate field."
property :org, String,
- description: "Value for the O certificate field."
+ description: "Value for the `O` certificate field."
property :org_unit, String,
- description: "Value for the OU certificate field."
+ description: "Value for the `OU` certificate field."
property :common_name, String,
required: true,
- description: "Value for the CN certificate field."
+ description: "Value for the `CN` certificate field."
property :email, String,
- description: "Value for the email certificate field."
+ description: "Value for the `email` certificate field."
property :key_file, String,
- description: "The path to a certificate key file on the filesystem. If the key_file property is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the key_file property is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate."
+ description: "The path to a certificate key file on the filesystem. If the `key_file` property is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the `key_file` property is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate."
property :key_pass, String,
description: "The passphrase for an existing key's passphrase."
property :key_type, String,
equal_to: %w{rsa ec}, default: "ec",
- description: "The desired type of the generated key (rsa or ec)."
+ description: "The desired type of the generated key."
property :key_length, Integer,
equal_to: [1024, 2048, 4096, 8192], default: 2048,
- description: "The desired bit length of the generated key (if key_type is equal to 'rsa')."
+ description: "The desired bit length of the generated key (if key_type is equal to `rsa`)."
property :key_curve, String,
equal_to: %w{secp384r1 secp521r1 prime256v1}, default: "prime256v1",
- description: "The desired curve of the generated key (if key_type is equal to 'ec'). Run openssl ecparam -list_curves to see available options."
-
- default_action :create
+ description: "The desired curve of the generated key (if key_type is equal to `ec`). Run `openssl ecparam -list_curves` to see available options."
action :create do
description "Generate a certificate request."