summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-08-30 11:37:26 -0700
committerTim Smith <tsmith@chef.io>2018-08-31 17:17:24 -0700
commit58c45a4231e2a810c39d7bb74cbcfbf725fa17f5 (patch)
treeffadc470c60281ea626623a3a029eebd1a17311c
parentf6e2f46325d906e4d8a569826db28fa561de37d0 (diff)
downloadchef-58c45a4231e2a810c39d7bb74cbcfbf725fa17f5.tar.gz
openssl_*: Update property descriptions and remove extra nil types
We allowed String, nil, which is a legacy thing that's not longer necessary. Just make these String. This syncs all the properties with what I just pushed up to the docs site. It cleans up some wording around owner/group properties and fixes typos. Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/resource/openssl_dhparam.rb8
-rw-r--r--lib/chef/resource/openssl_ec_private_key.rb6
-rw-r--r--lib/chef/resource/openssl_ec_public_key.rb4
-rw-r--r--lib/chef/resource/openssl_rsa_private_key.rb8
-rw-r--r--lib/chef/resource/openssl_rsa_public_key.rb8
-rw-r--r--lib/chef/resource/openssl_x509_certificate.rb4
-rw-r--r--lib/chef/resource/openssl_x509_crl.rb2
-rw-r--r--lib/chef/resource/openssl_x509_request.rb4
8 files changed, 22 insertions, 22 deletions
diff --git a/lib/chef/resource/openssl_dhparam.rb b/lib/chef/resource/openssl_dhparam.rb
index 1ad49948e8..3b0d264f8b 100644
--- a/lib/chef/resource/openssl_dhparam.rb
+++ b/lib/chef/resource/openssl_dhparam.rb
@@ -45,11 +45,11 @@ class Chef
description: "The desired Diffie-Hellmann generator.",
default: 2
- property :owner, [String, nil],
- description: "The owner of all files created by the resource."
+ property :owner, String,
+ description: "The owner applied to all files created by the resource."
- property :group, [String, nil],
- description: "The group of all files created by the resource."
+ property :group, String,
+ description: "The group ownership applied to all files created by the resource."
property :mode, [Integer, String],
description: "The permission mode applied to all files created by the resource.",
diff --git a/lib/chef/resource/openssl_ec_private_key.rb b/lib/chef/resource/openssl_ec_private_key.rb
index b3abc34313..ba02011fbf 100644
--- a/lib/chef/resource/openssl_ec_private_key.rb
+++ b/lib/chef/resource/openssl_ec_private_key.rb
@@ -27,7 +27,7 @@ class Chef
preview_resource true
resource_name :openssl_ec_private_key
- description "Use the openssl_ec_private_key resource to generate generate elliptic curve (EC) private key files. If a valid EC key file can be opened at the specified location, no new file will be created. If the EC key file cannot be opened, either because it does not exist or because the password to the EC key file does not match the password in the recipe, it will be overwritten."
+ description "Use the openssl_ec_private_key resource to generate an elliptic curve (EC) private key files. If a valid EC key file can be opened at the specified location, no new file will be created. If the EC key file cannot be opened, either because it does not exist or because the password to the EC key file does not match the password in the recipe, it will be overwritten."
introduced "14.4"
property :path, String,
@@ -49,10 +49,10 @@ class Chef
default: "des3"
property :owner, String,
- description: "The owner of all files created by the resource."
+ description: "The owner applied to all files created by the resource."
property :group, String,
- description: "The group of all files created by the resource."
+ description: "The group ownership applied to all files created by the resource."
property :mode, [Integer, String],
description: "The permission mode applied to all files created by the resource.",
diff --git a/lib/chef/resource/openssl_ec_public_key.rb b/lib/chef/resource/openssl_ec_public_key.rb
index 10f656e904..9b1ded4043 100644
--- a/lib/chef/resource/openssl_ec_public_key.rb
+++ b/lib/chef/resource/openssl_ec_public_key.rb
@@ -44,10 +44,10 @@ class Chef
description: "The passphrase of the provided private key."
property :owner, String,
- description: "The owner of all files created by the resource."
+ description: "The owner applied to all files created by the resource."
property :group, String,
- description: "The group of all files created by the resource."
+ description: "The group ownership applied to all files created by the resource."
property :mode, [Integer, String],
description: "The permission mode applied to all files created by the resource.",
diff --git a/lib/chef/resource/openssl_rsa_private_key.rb b/lib/chef/resource/openssl_rsa_private_key.rb
index 7155906fd9..f2c1400a30 100644
--- a/lib/chef/resource/openssl_rsa_private_key.rb
+++ b/lib/chef/resource/openssl_rsa_private_key.rb
@@ -49,11 +49,11 @@ class Chef
description: "The designed cipher to use when generating your key. Run `openssl list-cipher-algorithms` to see available options.",
default: "des3"
- property :owner, [String, nil],
- description: "The owner of all files created by the resource."
+ property :owner, String,
+ description: "The owner applied to all files created by the resource."
- property :group, [String, nil],
- description: "The group of all files created by the resource."
+ property :group, String,
+ description: "The group ownership applied to all files created by the resource."
property :mode, [Integer, String],
description: "The permission mode applied to all files created by the resource.",
diff --git a/lib/chef/resource/openssl_rsa_public_key.rb b/lib/chef/resource/openssl_rsa_public_key.rb
index e33e176e11..c213284235 100644
--- a/lib/chef/resource/openssl_rsa_public_key.rb
+++ b/lib/chef/resource/openssl_rsa_public_key.rb
@@ -42,11 +42,11 @@ class Chef
property :private_key_pass, String,
description: "The passphrase of the provided private key."
- property :owner, [String, nil],
- description: "The owner of all files created by the resource."
+ property :owner, String,
+ description: "The owner applied to all files created by the resource."
- property :group, [String, nil],
- description: "The group of all files created by the resource."
+ property :group, String,
+ description: "The group ownership applied to all files created by the resource."
property :mode, [Integer, String],
description: "The permission mode applied to all files created by the resource.",
diff --git a/lib/chef/resource/openssl_x509_certificate.rb b/lib/chef/resource/openssl_x509_certificate.rb
index c9dfeb9e68..fcbcc650a0 100644
--- a/lib/chef/resource/openssl_x509_certificate.rb
+++ b/lib/chef/resource/openssl_x509_certificate.rb
@@ -36,10 +36,10 @@ class Chef
name_property: true
property :owner, String,
- description: "The owner of all files created by the resource."
+ description: "The owner applied to all files created by the resource."
property :group, String,
- description: "The group of all files created by the resource."
+ description: "The group ownership applied to all files created by the resource."
property :expire, Integer,
description: "Value representing the number of days from now through which the issued certificate cert will remain valid. The certificate will expire after this period.",
diff --git a/lib/chef/resource/openssl_x509_crl.rb b/lib/chef/resource/openssl_x509_crl.rb
index 477d17b1b6..06f73bdd51 100644
--- a/lib/chef/resource/openssl_x509_crl.rb
+++ b/lib/chef/resource/openssl_x509_crl.rb
@@ -38,7 +38,7 @@ class Chef
description: "Serial of the X509 Certificate to revoke."
property :revocation_reason, Integer,
- description: "Reason for the revokation.",
+ description: "Reason for the revocation.",
default: 0
property :expire, Integer,
diff --git a/lib/chef/resource/openssl_x509_request.rb b/lib/chef/resource/openssl_x509_request.rb
index 00e8131f5c..a553e38a89 100644
--- a/lib/chef/resource/openssl_x509_request.rb
+++ b/lib/chef/resource/openssl_x509_request.rb
@@ -34,10 +34,10 @@ class Chef
description: "The optional path to write the file to if you'd like to specify it here instead of in the resource name."
property :owner, String,
- description: "The owner of all files created by the resource."
+ description: "The owner applied to all files created by the resource."
property :group, String,
- description: "The group of all files created by the resource."
+ description: "The group ownership applied to all files created by the resource."
property :mode, [Integer, String],
description: "The permission mode applied to all files created by the resource."